POST api/sms/send-message
Request Information
URI Parameters
None.
Body Parameters
SendMessageRequestName | 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": "39f15beb-98d5-4b06-8f67-00ae172f19ea", "agencyId": "774a4f45-7fc9-49a1-8190-211295a3aa9f", "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>774a4f45-7fc9-49a1-8190-211295a3aa9f</_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>39f15beb-98d5-4b06-8f67-00ae172f19ea</_x003C_UserId_x003E_k__BackingField> </SendMessageRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
NowCertsApiResultOfSendMessageResultName | Description | Type | Additional information |
---|---|---|---|
Status | ApiStatus |
None. |
|
Data | SendMessageResult |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "status": 0, "data": { "id": "5806277b-5ead-4f49-b232-d2f1883d3e35", "createDate": "2025-07-03T22:41:33.1134098-05:00", "insuranceAgencyId": "9e6f3f9c-7090-4ae9-a0ff-65626904aae4", "lastChangeUserId": "d6260c72-b6bd-47ea-8ec7-7a98dc2a5a74", "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-07-03T22:41:33.1134098-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>5806277b-5ead-4f49-b232-d2f1883d3e35</d2p1:_x003C_Id_x003E_k__BackingField> <d2p1:_x003C_InsuranceAgencyId_x003E_k__BackingField>9e6f3f9c-7090-4ae9-a0ff-65626904aae4</d2p1:_x003C_InsuranceAgencyId_x003E_k__BackingField> <d2p1:_x003C_LastChangeUserId_x003E_k__BackingField>d6260c72-b6bd-47ea-8ec7-7a98dc2a5a74</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>