GET api/sms/get-user-message-subscriptions?UserId={UserId}&AgencyId={AgencyId}

Request Information

URI Parameters

Name	Description	Type	Additional information
UserId		globally unique identifier	None.
AgencyId		globally unique identifier	None.

Body Parameters

None.

Response Information

Resource Description

Collection of MessageSubscriptionDto

Name	Type	Additional information
Id	globally unique identifier	None.
ChangeDate	date	None.
CreateDate	date	None.
PhoneNumberFrom	string	None.
UserPhoneNumber	string	None.
WebhookUrl	string	None.
IsAutoUnsubscribe	boolean	None.
IsActive	boolean	None.
InactiveMessage	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": "3f9311fa-4b73-4d61-b1f2-d3e469d2f4db",
    "changeDate": "2024-05-08T04:48:42.2621458-05:00",
    "createDate": "2024-05-08T04:48:42.2621458-05:00",
    "phoneNumberFrom": "sample string 4",
    "userPhoneNumber": "sample string 5",
    "webhookUrl": "sample string 6",
    "isAutoUnsubscribe": true,
    "isActive": true,
    "inactiveMessage": "sample string 9"
  },
  {
    "id": "3f9311fa-4b73-4d61-b1f2-d3e469d2f4db",
    "changeDate": "2024-05-08T04:48:42.2621458-05:00",
    "createDate": "2024-05-08T04:48:42.2621458-05:00",
    "phoneNumberFrom": "sample string 4",
    "userPhoneNumber": "sample string 5",
    "webhookUrl": "sample string 6",
    "isAutoUnsubscribe": true,
    "isActive": true,
    "inactiveMessage": "sample string 9"
  }
]

application/xml, text/xml

Sample:

<ArrayOfMessageSubscriptionDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.OData.SMS">
  <MessageSubscriptionDto>
    <ChangeDate>2024-05-08T04:48:42.2621458-05:00</ChangeDate>
    <CreateDate>2024-05-08T04:48:42.2621458-05:00</CreateDate>
    <Id>3f9311fa-4b73-4d61-b1f2-d3e469d2f4db</Id>
    <InactiveMessage>sample string 9</InactiveMessage>
    <IsActive>true</IsActive>
    <IsAutoUnsubscribe>true</IsAutoUnsubscribe>
    <PhoneNumberFrom>sample string 4</PhoneNumberFrom>
    <UserPhoneNumber>sample string 5</UserPhoneNumber>
    <WebhookUrl>sample string 6</WebhookUrl>
  </MessageSubscriptionDto>
  <MessageSubscriptionDto>
    <ChangeDate>2024-05-08T04:48:42.2621458-05:00</ChangeDate>
    <CreateDate>2024-05-08T04:48:42.2621458-05:00</CreateDate>
    <Id>3f9311fa-4b73-4d61-b1f2-d3e469d2f4db</Id>
    <InactiveMessage>sample string 9</InactiveMessage>
    <IsActive>true</IsActive>
    <IsAutoUnsubscribe>true</IsAutoUnsubscribe>
    <PhoneNumberFrom>sample string 4</PhoneNumberFrom>
    <UserPhoneNumber>sample string 5</UserPhoneNumber>
    <WebhookUrl>sample string 6</WebhookUrl>
  </MessageSubscriptionDto>
</ArrayOfMessageSubscriptionDto>