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": "011cac98-0e45-4161-8c45-d836d4c907c2", "agencyId": "d0bc565d-a39d-49b3-a5b8-1566a77a1f35", "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>d0bc565d-a39d-49b3-a5b8-1566a77a1f35</_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>011cac98-0e45-4161-8c45-d836d4c907c2</_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": "4570f63e-75d3-4495-b246-316bc251c39e", "createDate": "2025-05-30T21:16:36.5888032-05:00", "insuranceAgencyId": "71fd1487-227d-479e-b5f8-5b910273a0a4", "lastChangeUserId": "07ae6e5e-f0ac-456f-af6a-f6e47f2e01a8", "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-05-30T21:16:36.5888032-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>4570f63e-75d3-4495-b246-316bc251c39e</d2p1:_x003C_Id_x003E_k__BackingField> <d2p1:_x003C_InsuranceAgencyId_x003E_k__BackingField>71fd1487-227d-479e-b5f8-5b910273a0a4</d2p1:_x003C_InsuranceAgencyId_x003E_k__BackingField> <d2p1:_x003C_LastChangeUserId_x003E_k__BackingField>07ae6e5e-f0ac-456f-af6a-f6e47f2e01a8</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>