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

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional 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": "ed257aae-ff6b-463f-89b0-cf9280c3fe6c",
  "agencyId": "10b2533c-1a71-49b0-865a-2b985d80b5f3",
  "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>10b2533c-1a71-49b0-865a-2b985d80b5f3</AgencyId>
  <IsAutoUnsubscribe>true</IsAutoUnsubscribe>
  <PhoneNumberFrom>sample string 2</PhoneNumberFrom>
  <UserId>ed257aae-ff6b-463f-89b0-cf9280c3fe6c</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

Name	Type	Additional information
DatabaseId	globally unique identifier	None.
Status	ApiStatus	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "databaseId": "fdc81a46-8699-4d54-97f9-a3dc4587d2ea",
  "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>fdc81a46-8699-4d54-97f9-a3dc4587d2ea</DatabaseId>
</NowCertsApiResultWithDatabaseId>