POST api/sms/send-mass-message
Request Information
URI Parameters
None.
Body Parameters
SendMassMessageRequestName | Description | Type | Additional information |
---|---|---|---|
UserId | globally unique identifier |
None. |
|
AgencyId | globally unique identifier |
None. |
|
ToPhoneNumberArray | Collection of string |
None. |
|
TextMessage | string |
None. |
|
Attachments | Collection of AttachmentFile |
None. |
|
SubscriptionResponseWebhookUrl | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "userId": "3639e7d0-aa7c-4065-866b-50fa0ff45ee7", "agencyId": "81d884fb-1f3a-4725-9bde-b4efdf70eb9c", "toPhoneNumberArray": [ "sample string 1", "sample string 2" ], "textMessage": "sample string 3", "attachments": [ { "fileBytes": "QEA=", "mime": "sample string 1", "fileName": "sample string 2" }, { "fileBytes": "QEA=", "mime": "sample string 1", "fileName": "sample string 2" } ], "subscriptionResponseWebhookUrl": "sample string 4" }
application/xml, text/xml
Sample:
<SendMassMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.OData.SMS"> <_x003C_AgencyId_x003E_k__BackingField>81d884fb-1f3a-4725-9bde-b4efdf70eb9c</_x003C_AgencyId_x003E_k__BackingField> <_x003C_Attachments_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/NowCerts.Domain.Common.Models"> <d2p1:AttachmentFile> <d2p1:FileBytes>QEA=</d2p1:FileBytes> <d2p1:FileName>sample string 2</d2p1:FileName> <d2p1:MIME>sample string 1</d2p1:MIME> </d2p1:AttachmentFile> <d2p1:AttachmentFile> <d2p1:FileBytes>QEA=</d2p1:FileBytes> <d2p1:FileName>sample string 2</d2p1:FileName> <d2p1:MIME>sample string 1</d2p1:MIME> </d2p1:AttachmentFile> </_x003C_Attachments_x003E_k__BackingField> <_x003C_SubscriptionResponseWebhookUrl_x003E_k__BackingField>sample string 4</_x003C_SubscriptionResponseWebhookUrl_x003E_k__BackingField> <_x003C_TextMessage_x003E_k__BackingField>sample string 3</_x003C_TextMessage_x003E_k__BackingField> <_x003C_ToPhoneNumberArray_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </_x003C_ToPhoneNumberArray_x003E_k__BackingField> <_x003C_UserId_x003E_k__BackingField>3639e7d0-aa7c-4065-866b-50fa0ff45ee7</_x003C_UserId_x003E_k__BackingField> </SendMassMessageRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
NowCertsApiResultWithClassListOfSendMessageResultName | Description | Type | Additional information |
---|---|---|---|
Status | ApiStatus |
None. |
|
Data | Collection of SendMessageResult |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "status": 0, "data": [ { "id": "04513913-9f11-4e3a-a5ad-a2b911b820dc", "createDate": "2025-06-24T06:19:17.7049731-05:00", "insuranceAgencyId": "eae8f1ef-1899-487f-9892-20f758d914dd", "lastChangeUserId": "b209ad40-8dd9-470e-9154-02bcafe80ed4", "fromNumber": "sample string 5", "toNumber": "sample string 6", "subject": "sample string 7" }, { "id": "04513913-9f11-4e3a-a5ad-a2b911b820dc", "createDate": "2025-06-24T06:19:17.7049731-05:00", "insuranceAgencyId": "eae8f1ef-1899-487f-9892-20f758d914dd", "lastChangeUserId": "b209ad40-8dd9-470e-9154-02bcafe80ed4", "fromNumber": "sample string 5", "toNumber": "sample string 6", "subject": "sample string 7" } ], "message": "sample string 1" }
application/xml, text/xml
Sample:
<NowCertsApiResultWithClassListOfSendMessageResultuwwjCqqQ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum"> <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessEntities.OData.SMS"> <d2p1:SendMessageResult> <d2p1:_x003C_CreateDate_x003E_k__BackingField>2025-06-24T06:19:17.7049731-05:00</d2p1:_x003C_CreateDate_x003E_k__BackingField> <d2p1:_x003C_FromNumber_x003E_k__BackingField>sample string 5</d2p1:_x003C_FromNumber_x003E_k__BackingField> <d2p1:_x003C_Id_x003E_k__BackingField>04513913-9f11-4e3a-a5ad-a2b911b820dc</d2p1:_x003C_Id_x003E_k__BackingField> <d2p1:_x003C_InsuranceAgencyId_x003E_k__BackingField>eae8f1ef-1899-487f-9892-20f758d914dd</d2p1:_x003C_InsuranceAgencyId_x003E_k__BackingField> <d2p1:_x003C_LastChangeUserId_x003E_k__BackingField>b209ad40-8dd9-470e-9154-02bcafe80ed4</d2p1:_x003C_LastChangeUserId_x003E_k__BackingField> <d2p1:_x003C_Subject_x003E_k__BackingField>sample string 7</d2p1:_x003C_Subject_x003E_k__BackingField> <d2p1:_x003C_ToNumber_x003E_k__BackingField>sample string 6</d2p1:_x003C_ToNumber_x003E_k__BackingField> </d2p1:SendMessageResult> <d2p1:SendMessageResult> <d2p1:_x003C_CreateDate_x003E_k__BackingField>2025-06-24T06:19:17.7049731-05:00</d2p1:_x003C_CreateDate_x003E_k__BackingField> <d2p1:_x003C_FromNumber_x003E_k__BackingField>sample string 5</d2p1:_x003C_FromNumber_x003E_k__BackingField> <d2p1:_x003C_Id_x003E_k__BackingField>04513913-9f11-4e3a-a5ad-a2b911b820dc</d2p1:_x003C_Id_x003E_k__BackingField> <d2p1:_x003C_InsuranceAgencyId_x003E_k__BackingField>eae8f1ef-1899-487f-9892-20f758d914dd</d2p1:_x003C_InsuranceAgencyId_x003E_k__BackingField> <d2p1:_x003C_LastChangeUserId_x003E_k__BackingField>b209ad40-8dd9-470e-9154-02bcafe80ed4</d2p1:_x003C_LastChangeUserId_x003E_k__BackingField> <d2p1:_x003C_Subject_x003E_k__BackingField>sample string 7</d2p1:_x003C_Subject_x003E_k__BackingField> <d2p1:_x003C_ToNumber_x003E_k__BackingField>sample string 6</d2p1:_x003C_ToNumber_x003E_k__BackingField> </d2p1:SendMessageResult> </Data> <Message>sample string 1</Message> <Status>Error</Status> </NowCertsApiResultWithClassListOfSendMessageResultuwwjCqqQ>