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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
UserId

globally unique identifier

None.

AgencyId

globally unique identifier

None.

Body Parameters

None.

Response Information

Resource Description

Collection of MessageSubscriptionDto
NameDescriptionTypeAdditional 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": "61f7b7b2-3c8f-4da7-8df5-f1af331a0655",
    "changeDate": "2024-12-07T21:55:08.6964055-06:00",
    "createDate": "2024-12-07T21:55:08.6964055-06:00",
    "phoneNumberFrom": "sample string 4",
    "userPhoneNumber": "sample string 5",
    "webhookUrl": "sample string 6",
    "isAutoUnsubscribe": true,
    "isActive": true,
    "inactiveMessage": "sample string 9"
  },
  {
    "id": "61f7b7b2-3c8f-4da7-8df5-f1af331a0655",
    "changeDate": "2024-12-07T21:55:08.6964055-06:00",
    "createDate": "2024-12-07T21:55:08.6964055-06: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>
    <_x003C_ChangeDate_x003E_k__BackingField>2024-12-07T21:55:08.6964055-06:00</_x003C_ChangeDate_x003E_k__BackingField>
    <_x003C_CreateDate_x003E_k__BackingField>2024-12-07T21:55:08.6964055-06:00</_x003C_CreateDate_x003E_k__BackingField>
    <_x003C_Id_x003E_k__BackingField>61f7b7b2-3c8f-4da7-8df5-f1af331a0655</_x003C_Id_x003E_k__BackingField>
    <_x003C_InactiveMessage_x003E_k__BackingField>sample string 9</_x003C_InactiveMessage_x003E_k__BackingField>
    <_x003C_IsActive_x003E_k__BackingField>true</_x003C_IsActive_x003E_k__BackingField>
    <_x003C_IsAutoUnsubscribe_x003E_k__BackingField>true</_x003C_IsAutoUnsubscribe_x003E_k__BackingField>
    <_x003C_PhoneNumberFrom_x003E_k__BackingField>sample string 4</_x003C_PhoneNumberFrom_x003E_k__BackingField>
    <_x003C_UserPhoneNumber_x003E_k__BackingField>sample string 5</_x003C_UserPhoneNumber_x003E_k__BackingField>
    <_x003C_WebhookUrl_x003E_k__BackingField>sample string 6</_x003C_WebhookUrl_x003E_k__BackingField>
  </MessageSubscriptionDto>
  <MessageSubscriptionDto>
    <_x003C_ChangeDate_x003E_k__BackingField>2024-12-07T21:55:08.6964055-06:00</_x003C_ChangeDate_x003E_k__BackingField>
    <_x003C_CreateDate_x003E_k__BackingField>2024-12-07T21:55:08.6964055-06:00</_x003C_CreateDate_x003E_k__BackingField>
    <_x003C_Id_x003E_k__BackingField>61f7b7b2-3c8f-4da7-8df5-f1af331a0655</_x003C_Id_x003E_k__BackingField>
    <_x003C_InactiveMessage_x003E_k__BackingField>sample string 9</_x003C_InactiveMessage_x003E_k__BackingField>
    <_x003C_IsActive_x003E_k__BackingField>true</_x003C_IsActive_x003E_k__BackingField>
    <_x003C_IsAutoUnsubscribe_x003E_k__BackingField>true</_x003C_IsAutoUnsubscribe_x003E_k__BackingField>
    <_x003C_PhoneNumberFrom_x003E_k__BackingField>sample string 4</_x003C_PhoneNumberFrom_x003E_k__BackingField>
    <_x003C_UserPhoneNumber_x003E_k__BackingField>sample string 5</_x003C_UserPhoneNumber_x003E_k__BackingField>
    <_x003C_WebhookUrl_x003E_k__BackingField>sample string 6</_x003C_WebhookUrl_x003E_k__BackingField>
  </MessageSubscriptionDto>
</ArrayOfMessageSubscriptionDto>