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": "1c2a8b47-a5d0-421a-bc53-9682daec5d22", "agencyId": "c1dcb144-443a-4b66-954b-93dba6cd84a4", "toPhoneNumberArray": [ "sample string 1", "sample string 2" ], "textMessage": "sample string 3", "attachments": [ { "fileBytes": "QEA=", "mime": "sample string 1" }, { "fileBytes": "QEA=", "mime": "sample string 1" } ], "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"> <AgencyId>c1dcb144-443a-4b66-954b-93dba6cd84a4</AgencyId> <Attachments> <AttachmentFile> <FileBytes>QEA=</FileBytes> <MIME>sample string 1</MIME> </AttachmentFile> <AttachmentFile> <FileBytes>QEA=</FileBytes> <MIME>sample string 1</MIME> </AttachmentFile> </Attachments> <SubscriptionResponseWebhookUrl>sample string 4</SubscriptionResponseWebhookUrl> <TextMessage>sample string 3</TextMessage> <ToPhoneNumberArray xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </ToPhoneNumberArray> <UserId>1c2a8b47-a5d0-421a-bc53-9682daec5d22</UserId> </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": "5ebde9ad-e12a-4997-bcf4-259ee05243c1", "createDate": "2024-05-08T22:31:10.1415458-05:00", "insuranceAgencyId": "978e0414-ec75-4400-8f98-661eb3b94380", "lastChangeUserId": "b5a84137-b877-481b-9200-03c3db03f297", "fromNumber": "sample string 5", "toNumber": "sample string 6", "subject": "sample string 7" }, { "id": "5ebde9ad-e12a-4997-bcf4-259ee05243c1", "createDate": "2024-05-08T22:31:10.1415458-05:00", "insuranceAgencyId": "978e0414-ec75-4400-8f98-661eb3b94380", "lastChangeUserId": "b5a84137-b877-481b-9200-03c3db03f297", "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:CreateDate>2024-05-08T22:31:10.1415458-05:00</d2p1:CreateDate> <d2p1:FromNumber>sample string 5</d2p1:FromNumber> <d2p1:Id>5ebde9ad-e12a-4997-bcf4-259ee05243c1</d2p1:Id> <d2p1:InsuranceAgencyId>978e0414-ec75-4400-8f98-661eb3b94380</d2p1:InsuranceAgencyId> <d2p1:LastChangeUserId>b5a84137-b877-481b-9200-03c3db03f297</d2p1:LastChangeUserId> <d2p1:Subject>sample string 7</d2p1:Subject> <d2p1:ToNumber>sample string 6</d2p1:ToNumber> </d2p1:SendMessageResult> <d2p1:SendMessageResult> <d2p1:CreateDate>2024-05-08T22:31:10.1415458-05:00</d2p1:CreateDate> <d2p1:FromNumber>sample string 5</d2p1:FromNumber> <d2p1:Id>5ebde9ad-e12a-4997-bcf4-259ee05243c1</d2p1:Id> <d2p1:InsuranceAgencyId>978e0414-ec75-4400-8f98-661eb3b94380</d2p1:InsuranceAgencyId> <d2p1:LastChangeUserId>b5a84137-b877-481b-9200-03c3db03f297</d2p1:LastChangeUserId> <d2p1:Subject>sample string 7</d2p1:Subject> <d2p1:ToNumber>sample string 6</d2p1:ToNumber> </d2p1:SendMessageResult> </Data> <Message>sample string 1</Message> <Status>Error</Status> </NowCertsApiResultWithClassListOfSendMessageResultuwwjCqqQ>