POST api/sms/send-message

Request Information

URI Parameters

None.

Body Parameters

SendMessageRequest
NameDescriptionTypeAdditional 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": "50448049-c0b9-48bd-8a44-36a8bbfdb193",
  "agencyId": "0d0f96a7-0ea1-44d9-89e9-b08da993ce0b",
  "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>0d0f96a7-0ea1-44d9-89e9-b08da993ce0b</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>50448049-c0b9-48bd-8a44-36a8bbfdb193</UserId>
</SendMessageRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

NowCertsApiResultOfSendMessageResult
NameDescriptionTypeAdditional information
Status

ApiStatus

None.

Data

SendMessageResult

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "status": 0,
  "data": {
    "id": "18ccac2a-ea93-4b83-b37f-c1c13e4b11f4",
    "createDate": "2024-04-19T05:51:23.6551963-05:00",
    "insuranceAgencyId": "7ad903be-c593-4f04-9322-ebf302a9bbc6",
    "lastChangeUserId": "13ca38f1-457c-4c54-84bb-4b101d419fac",
    "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-04-19T05:51:23.6551963-05:00</d2p1:CreateDate>
    <d2p1:FromNumber>sample string 5</d2p1:FromNumber>
    <d2p1:Id>18ccac2a-ea93-4b83-b37f-c1c13e4b11f4</d2p1:Id>
    <d2p1:InsuranceAgencyId>7ad903be-c593-4f04-9322-ebf302a9bbc6</d2p1:InsuranceAgencyId>
    <d2p1:LastChangeUserId>13ca38f1-457c-4c54-84bb-4b101d419fac</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>