POST api/sms/send-message

Request Information

URI Parameters

None.

Body Parameters

Name	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": "f80e1aa8-9709-474f-b0ff-a206a929fa52",
  "agencyId": "e7e5b8ad-ba37-474b-a8be-99045db5f69e",
  "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>e7e5b8ad-ba37-474b-a8be-99045db5f69e</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>f80e1aa8-9709-474f-b0ff-a206a929fa52</UserId>
</SendMessageRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

NowCertsApiResultOfSendMessageResult

Name	Type	Additional information
Status	ApiStatus	None.
Data	SendMessageResult	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "status": 0,
  "data": {
    "id": "733bcf3a-4143-438a-b4b9-7f349ef0af94",
    "createDate": "2024-05-08T21:52:22.8576848-05:00",
    "insuranceAgencyId": "868220b3-49da-4a05-840b-201e014e37df",
    "lastChangeUserId": "a87c8879-3d19-4b9c-afc2-dcef2315e54f",
    "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-08T21:52:22.8576848-05:00</d2p1:CreateDate>
    <d2p1:FromNumber>sample string 5</d2p1:FromNumber>
    <d2p1:Id>733bcf3a-4143-438a-b4b9-7f349ef0af94</d2p1:Id>
    <d2p1:InsuranceAgencyId>868220b3-49da-4a05-840b-201e014e37df</d2p1:InsuranceAgencyId>
    <d2p1:LastChangeUserId>a87c8879-3d19-4b9c-afc2-dcef2315e54f</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>