POST api/sms/send-mass-message
Request Information
URI Parameters
None.
Body Parameters
SendMassMessageRequest| Name | 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": "f56102fd-2e53-49f3-ab00-67fe3d5fe9fd",
"agencyId": "a6889454-d554-49f2-9719-76cc1a72534b",
"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>a6889454-d554-49f2-9719-76cc1a72534b</_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>f56102fd-2e53-49f3-ab00-67fe3d5fe9fd</_x003C_UserId_x003E_k__BackingField>
</SendMassMessageRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
NowCertsApiResultWithClassListOfSendMessageResult| Name | 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": "03009398-d839-4c9f-b1ec-87f9560d3a5d",
"createDate": "2025-12-05T07:35:44.6682036-06:00",
"insuranceAgencyId": "4d95a20f-e288-4958-bffc-0e0ff4215da0",
"lastChangeUserId": "a6e07af5-1a58-4216-a32e-fd4b7d50f900",
"fromNumber": "sample string 5",
"toNumber": "sample string 6",
"subject": "sample string 7"
},
{
"id": "03009398-d839-4c9f-b1ec-87f9560d3a5d",
"createDate": "2025-12-05T07:35:44.6682036-06:00",
"insuranceAgencyId": "4d95a20f-e288-4958-bffc-0e0ff4215da0",
"lastChangeUserId": "a6e07af5-1a58-4216-a32e-fd4b7d50f900",
"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-12-05T07:35:44.6682036-06: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>03009398-d839-4c9f-b1ec-87f9560d3a5d</d2p1:_x003C_Id_x003E_k__BackingField>
<d2p1:_x003C_InsuranceAgencyId_x003E_k__BackingField>4d95a20f-e288-4958-bffc-0e0ff4215da0</d2p1:_x003C_InsuranceAgencyId_x003E_k__BackingField>
<d2p1:_x003C_LastChangeUserId_x003E_k__BackingField>a6e07af5-1a58-4216-a32e-fd4b7d50f900</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-12-05T07:35:44.6682036-06: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>03009398-d839-4c9f-b1ec-87f9560d3a5d</d2p1:_x003C_Id_x003E_k__BackingField>
<d2p1:_x003C_InsuranceAgencyId_x003E_k__BackingField>4d95a20f-e288-4958-bffc-0e0ff4215da0</d2p1:_x003C_InsuranceAgencyId_x003E_k__BackingField>
<d2p1:_x003C_LastChangeUserId_x003E_k__BackingField>a6e07af5-1a58-4216-a32e-fd4b7d50f900</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>