POST api/sms/subscribe-for-inbound-message

Request Information

URI Parameters

None.

Body Parameters

SubscribeForInboundMessageRequest
NameDescriptionTypeAdditional information
UserPhoneNumber

string

None.

PhoneNumberFrom

string

None.

WebhookUrl

string

None.

UserId

globally unique identifier

None.

AgencyId

globally unique identifier

None.

IsAutoUnsubscribe

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "userPhoneNumber": "sample string 1",
  "phoneNumberFrom": "sample string 2",
  "webhookUrl": "sample string 3",
  "userId": "91f450bb-41eb-48f5-9935-dc202a2cbd9b",
  "agencyId": "bae0b288-591b-40fe-8e52-7e165a924afa",
  "isAutoUnsubscribe": true
}

application/xml, text/xml

Sample:
<SubscribeForInboundMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.OData.SMS">
  <AgencyId>bae0b288-591b-40fe-8e52-7e165a924afa</AgencyId>
  <IsAutoUnsubscribe>true</IsAutoUnsubscribe>
  <PhoneNumberFrom>sample string 2</PhoneNumberFrom>
  <UserId>91f450bb-41eb-48f5-9935-dc202a2cbd9b</UserId>
  <UserPhoneNumber>sample string 1</UserPhoneNumber>
  <WebhookUrl>sample string 3</WebhookUrl>
</SubscribeForInboundMessageRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

NowCertsApiResultWithDatabaseId
NameDescriptionTypeAdditional information
DatabaseId

globally unique identifier

None.

Status

ApiStatus

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "databaseId": "9d85d519-3f70-4cd1-8afa-d49679c39377",
  "status": 0,
  "message": "sample string 2"
}

application/xml, text/xml

Sample:
<NowCertsApiResultWithDatabaseId xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum">
  <Message>sample string 2</Message>
  <Status>Error</Status>
  <DatabaseId>9d85d519-3f70-4cd1-8afa-d49679c39377</DatabaseId>
</NowCertsApiResultWithDatabaseId>