POST api/sms/subscribe-for-inbound-message
Request Information
URI Parameters
None.
Body Parameters
SubscribeForInboundMessageRequestName | Description | 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": "21ea5927-8a4b-4647-ab1c-d460228a00fa", "agencyId": "536ae26f-69e2-4177-b277-4412cbe31a48", "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>536ae26f-69e2-4177-b277-4412cbe31a48</AgencyId> <IsAutoUnsubscribe>true</IsAutoUnsubscribe> <PhoneNumberFrom>sample string 2</PhoneNumberFrom> <UserId>21ea5927-8a4b-4647-ab1c-d460228a00fa</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
NowCertsApiResultWithDatabaseIdName | Description | Type | Additional information |
---|---|---|---|
DatabaseId | globally unique identifier |
None. |
|
Status | ApiStatus |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "databaseId": "328ee161-3d0d-4c26-a30a-4c16da31c909", "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>328ee161-3d0d-4c26-a30a-4c16da31c909</DatabaseId> </NowCertsApiResultWithDatabaseId>