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": "38f097b7-b7cb-48b9-a04e-e8ff11c7f20e", "agencyId": "9ce15477-e7ec-4d6a-91cd-cddd67febc05", "toPhoneNumber": "sample string 3", "textMessage": "sample string 4", "attachments": [ { "fileBytes": "QEA=", "mime": "sample string 1" }, { "fileBytes": "QEA=", "mime": "sample string 1" } ], "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"> <AgencyId>9ce15477-e7ec-4d6a-91cd-cddd67febc05</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 5</SubscriptionResponseWebhookUrl> <TextMessage>sample string 4</TextMessage> <ToPhoneNumber>sample string 3</ToPhoneNumber> <UserId>38f097b7-b7cb-48b9-a04e-e8ff11c7f20e</UserId> </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": "0a57c92e-2c24-4b50-92d6-a17d455f59e8", "createDate": "2024-05-17T21:40:06.5761348-05:00", "insuranceAgencyId": "156eb954-7454-45c8-ad72-3a3d3e00d4e1", "lastChangeUserId": "e114a80e-3aac-47a7-8a83-7ec1db2f217e", "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:CreateDate>2024-05-17T21:40:06.5761348-05:00</d2p1:CreateDate> <d2p1:FromNumber>sample string 5</d2p1:FromNumber> <d2p1:Id>0a57c92e-2c24-4b50-92d6-a17d455f59e8</d2p1:Id> <d2p1:InsuranceAgencyId>156eb954-7454-45c8-ad72-3a3d3e00d4e1</d2p1:InsuranceAgencyId> <d2p1:LastChangeUserId>e114a80e-3aac-47a7-8a83-7ec1db2f217e</d2p1:LastChangeUserId> <d2p1:Subject>sample string 7</d2p1:Subject> <d2p1:ToNumber>sample string 6</d2p1:ToNumber> </Data> <Message>sample string 1</Message> <Status>Error</Status> </NowCertsApiResultOfSendMessageResultuwwjCqqQ>