POST api/sms/send-message
Request Information
URI Parameters
None.
Body Parameters
SendMessageRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | globally unique identifier |
None. |
|
| AgencyId | globally unique identifier |
None. |
|
| ToPhoneNumber | string |
None. |
|
| TextMessage | string |
None. |
|
| Attachments | Collection of AttachmentFile |
None. |
|
| SubscriptionResponseWebhookUrl | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"userId": "bd593c84-b317-4a34-ab79-4ed1a41de8fc",
"agencyId": "7f533445-ccd5-401e-9645-bed7c4963620",
"toPhoneNumber": "sample string 3",
"textMessage": "sample string 4",
"attachments": [
{
"fileBytes": "QEA=",
"mime": "sample string 1",
"fileName": "sample string 2"
},
{
"fileBytes": "QEA=",
"mime": "sample string 1",
"fileName": "sample string 2"
}
],
"subscriptionResponseWebhookUrl": "sample string 5"
}
application/xml, text/xml
Sample:
<SendMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.OData.SMS">
<_x003C_AgencyId_x003E_k__BackingField>7f533445-ccd5-401e-9645-bed7c4963620</_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 5</_x003C_SubscriptionResponseWebhookUrl_x003E_k__BackingField>
<_x003C_TextMessage_x003E_k__BackingField>sample string 4</_x003C_TextMessage_x003E_k__BackingField>
<_x003C_ToPhoneNumber_x003E_k__BackingField>sample string 3</_x003C_ToPhoneNumber_x003E_k__BackingField>
<_x003C_UserId_x003E_k__BackingField>bd593c84-b317-4a34-ab79-4ed1a41de8fc</_x003C_UserId_x003E_k__BackingField>
</SendMessageRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
NowCertsApiResultOfSendMessageResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | ApiStatus |
None. |
|
| Data | SendMessageResult |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"status": 0,
"data": {
"id": "130fd35d-7f4c-44ad-84a0-0f8465ff7e68",
"createDate": "2025-12-05T07:35:17.3466638-06:00",
"insuranceAgencyId": "f39fef2b-5016-4c7a-ab39-5ce0e3556d65",
"lastChangeUserId": "d4ecbbe3-c083-40fd-abfe-46aa9e02e203",
"fromNumber": "sample string 5",
"toNumber": "sample string 6",
"subject": "sample string 7"
},
"message": "sample string 1"
}
application/xml, text/xml
Sample:
<NowCertsApiResultOfSendMessageResultuwwjCqqQ 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:_x003C_CreateDate_x003E_k__BackingField>2025-12-05T07:35:17.3466638-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>130fd35d-7f4c-44ad-84a0-0f8465ff7e68</d2p1:_x003C_Id_x003E_k__BackingField>
<d2p1:_x003C_InsuranceAgencyId_x003E_k__BackingField>f39fef2b-5016-4c7a-ab39-5ce0e3556d65</d2p1:_x003C_InsuranceAgencyId_x003E_k__BackingField>
<d2p1:_x003C_LastChangeUserId_x003E_k__BackingField>d4ecbbe3-c083-40fd-abfe-46aa9e02e203</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>
</Data>
<Message>sample string 1</Message>
<Status>Error</Status>
</NowCertsApiResultOfSendMessageResultuwwjCqqQ>