Messages

POST api/Messages/Send

Schedule message for send

MethodEndpoint
Send https://stgportalone.processonepayments.com/Communication/api/Messages/Send

SendCommunicationMessageRequest

NameDescriptionTypeRequired*Additional information
PortalOneAuthenticationKey

PortalOne Authentication Key

string Yes
ExternalMessageId

External MessageId

string Yes
TemplateCode

Template Code

string Yes
Type

Communication Message Type

CommunicationMessageType No
Channel

Communication Message Channel

CommunicationMessageChannelType Yes
TimezoneId

Time Zone

string No
PhoneNumber

Phone Number. Required if Channel is Text or PhoneCall

string No
EmailAddress

Email Address. Required if Channel is Email

string No
CustomerId

Customer Id. Required if ExternalCustomerId is null or empty

globally unique identifier No
ExternalCustomerId

External Customer Id. Required if CustomerId is null or empty

string No
Properties

Some External Properties

Dictionary of string and string No
AccountId

Account Id

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

CommunicationMessageType

Possible enumeration values:

NameValueDescription
Message

1

Communication Message

Conversation

2

Payment Message for TextPay

VerificationCode

3

Message for Sending Verification Code

CommunicationMessageChannelType

Possible enumeration values:

NameValueDescription
Email

1

Email Communication Channel

Text

2

Text message Communication Channel

PhoneCall

3

Phone Call Communication Channel

Request Formats

 
                                
                                 {
  "PortalOneAuthenticationKey": "Authentication Key",
  "ExternalMessageId": "3d1daf56-8889-4462-be65-a8b31fba5589",
  "TemplateCode": "Payment_past_due",
  "Type": null,
  "Channel": 2,
  "TimezoneId": "America/Los_Angeles",
  "PhoneNumber": "19111111111",
  "EmailAddress": null,
  "CustomerId": null,
  "ExternalCustomerId": "789456123",
  "Properties": {
    "CustomerName": "John Gold",
    "AmountDue": "500",
    "PolicyNumber": "TEST123456"
  },
  "AccountId": null
}
                                
                                 <SendCommunicationMessageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Communication.Contracts.DataContracts">
  <AccountId i:nil="true" />
  <Channel>Text</Channel>
  <CustomerId i:nil="true" />
  <EmailAddress i:nil="true" />
  <ExternalCustomerId>789456123</ExternalCustomerId>
  <ExternalMessageId>3d1daf56-8889-4462-be65-a8b31fba5589</ExternalMessageId>
  <PhoneNumber>19111111111</PhoneNumber>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>CustomerName</d2p1:Key>
      <d2p1:Value>John Gold</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>AmountDue</d2p1:Key>
      <d2p1:Value>500</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>PolicyNumber</d2p1:Key>
      <d2p1:Value>TEST123456</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Properties>
  <TemplateCode>Payment_past_due</TemplateCode>
  <TimezoneId>America/Los_Angeles</TimezoneId>
  <Type i:nil="true" />
  <PortalOneAuthenticationKey>Authentication Key</PortalOneAuthenticationKey>
</SendCommunicationMessageRequest>

Response Information

SendCommunicationMessageResponse

NameDescriptionTypeRequired*Additional information
ExecutionResult

Execution Result

SendCommunicationMessageExecutionResult No
ExecutionResultDescription

Result Description

string No
ResponseCode

Response Code

string No
ResponseMessage

Response Message

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

SendCommunicationMessageExecutionResult

Possible enumeration values:

NameValueDescription
ValidationFailed

2

Send Communication Message Validation Failed

OptOutFailed

3

Send Communication Message OptOut Failed

Success

4

Send Communication Message Success

Response Formats

{
  "ExecutionResult": 4,
  "ExecutionResultDescription": null,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<SendCommunicationMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Communication.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <ExecutionResult>Success</ExecutionResult>
  <ExecutionResultDescription i:nil="true" />
</SendCommunicationMessageResponse>

POST api/Messages/SendBatch

Schedule collection of messages for send

MethodEndpoint
SendBatch https://stgportalone.processonepayments.com/Communication/api/Messages/SendBatch

SendCommunicationMessageBatchRequest

NameDescriptionTypeRequired*Additional information
Messages

Communication Messages

Collection of SendCommunicationMessage Yes
PortalOneAuthenticationKey

PortalOne Authentication Key

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

SendCommunicationMessage

NameDescriptionTypeRequired*Additional information
ExternalMessageId

External MessageId

string Yes
TemplateCode

Template Code

string Yes
Type

Communication Message Type

CommunicationMessageType No
Channel

Communication Message Channel

CommunicationMessageChannelType Yes
TimezoneId

Time Zone

string No
PhoneNumber

Phone Number. Required if Channel is Text or PhoneCall

string No
EmailAddress

Email Address. Required if Channel is Email

string No
CustomerId

Customer Id. Required if ExternalCustomerId is null or empty

globally unique identifier No
ExternalCustomerId

External Customer Id. Required if CustomerId is null or empty

string No
Properties

Some External Properties

Dictionary of string and string No
AccountId

Account Id

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "Messages": [
    {
      "ExternalMessageId": "3d1daf56-8889-4462-be65-a8b31fba5589",
      "TemplateCode": "Payment_past_due",
      "Type": null,
      "Channel": 2,
      "TimezoneId": "America/Los_Angeles",
      "PhoneNumber": "19111111111",
      "EmailAddress": null,
      "CustomerId": null,
      "ExternalCustomerId": "789456123",
      "Properties": {
        "CustomerName": "John Gold",
        "AmountDue": "500",
        "PolicyNumber": "TEST123456"
      },
      "AccountId": null
    },
    {
      "ExternalMessageId": "3d1daf56-8889-4462-be65-a8b31fba5589",
      "TemplateCode": "Payment_past_due",
      "Type": null,
      "Channel": 2,
      "TimezoneId": "America/Los_Angeles",
      "PhoneNumber": "19111111111",
      "EmailAddress": null,
      "CustomerId": null,
      "ExternalCustomerId": "789456123",
      "Properties": {
        "CustomerName": "John Gold",
        "AmountDue": "500",
        "PolicyNumber": "TEST123456"
      },
      "AccountId": null
    }
  ],
  "PortalOneAuthenticationKey": "Authentication Key"
}

Response Information

SendCommunicationMessageBatchResponse

NameDescriptionTypeRequired*Additional information
Results

Communication Messages

Collection of SendCommunicationMessageResult No
ResponseCode

Response Code

string No
ResponseMessage

Response Message

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

SendCommunicationMessageResult

NameDescriptionTypeRequired*Additional information
ExternalMessageId

External Message Id

string No
ExecutionResult

Communication Message Execution Result

SendCommunicationMessageExecutionResult No
ExecutionResultDescription

Result Description

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "Results": [
    {
      "ExternalMessageId": "3d1daf56-8889-4462-be65-a8b31fba5589",
      "ExecutionResult": 4,
      "ExecutionResultDescription": null
    },
    {
      "ExternalMessageId": "3d1daf56-8889-4462-be65-a8b31fba5589",
      "ExecutionResult": 4,
      "ExecutionResultDescription": null
    }
  ],
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<SendCommunicationMessageBatchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Communication.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <Results>
    <SendCommunicationMessageResult>
      <ExecutionResult>Success</ExecutionResult>
      <ExecutionResultDescription i:nil="true" />
      <ExternalMessageId>3d1daf56-8889-4462-be65-a8b31fba5589</ExternalMessageId>
    </SendCommunicationMessageResult>
    <SendCommunicationMessageResult>
      <ExecutionResult>Success</ExecutionResult>
      <ExecutionResultDescription i:nil="true" />
      <ExternalMessageId>3d1daf56-8889-4462-be65-a8b31fba5589</ExternalMessageId>
    </SendCommunicationMessageResult>
  </Results>
</SendCommunicationMessageBatchResponse>

GET api/Messages/Get?ExternalMessageId={ExternalMessageId}&PortalOneAuthenticationKey={PortalOneAuthenticationKey}

Get message info by ExternalMessageId

MethodEndpoint
Get https://stgportalone.processonepayments.com/Communication/api/Messages/Get?ExternalMessageId={ExternalMessageId}&PortalOneAuthenticationKey={PortalOneAuthenticationKey}

URI Parameters

NameDescriptionTypeRequired*Additional information
ExternalMessageId

External Message Id

string Yes
PortalOneAuthenticationKey

PortalOne Authentication Key

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

String

Request Formats

 

Response Information

GetCommunicationMessageResponse

NameDescriptionTypeRequired*Additional information
ExecutionResultDescription

Result Description

string No
CommunicationMessage

Communication Message

GetCommunicationMessageSnapshotDto No
ResponseCode

Response Code

string No
ResponseMessage

Response Message

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

GetCommunicationMessageSnapshotDto

NameDescriptionTypeRequired*Additional information
CommunicationMessageId

Communication Message Id

integer No
MessageExternalId

External Message Id

string No
Channel

Communication Message Chanel

CommunicationMessageChannelType No
Payload

Payload

string No
MessageStatus

Communication Message Status

CommunicationMessageStatus No
StatusDescription

Status Description

string No
Timezone

Timezone

string No
ExpirationDateUtc

Expiration Date in UTC format

date No
LastUpdatedDateUtc

Last Updated Date in UTC format

date No
SendingDateUtc

Sending Date in UTC format

date No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

CommunicationMessageStatus

Possible enumeration values:

NameValueDescription
New

1

New Communication Message

IgnoredDueValidation

2

Ignored Due Validation Communication Message

IgnoredDueOptOut

3

Ignored Due OptOut Validation Communication Message

Scheduled

4

Scheduled Communication Message

Sent

5

Sent Communication Message

FailedToSend

6

Failed to Send Communication Message

Delivered

7

Delivered Communication Message

DeliveredWithComplaint

8

Delivered With Complaint Communication Message

Bounced

9

Bounced Communication Message

AwaitingOptIn

10

Awaiting OptIn Communication Message

IgnoredDueAwaitingOptIn

11

Ignored Due Awaiting OptIn Communication Message

Response Formats

{
  "ExecutionResultDescription": null,
  "CommunicationMessage": {
    "CommunicationMessageId": 14123,
    "MessageExternalId": "3d1daf56-8889-4462-be65-a8b31fba5589",
    "Channel": 2,
    "Payload": "123",
    "MessageStatus": 7,
    "StatusDescription": "Success",
    "Timezone": "America/Los_Angeles",
    "ExpirationDateUtc": "2020-10-29T00:00:00",
    "LastUpdatedDateUtc": "2020-10-27T00:00:00",
    "SendingDateUtc": "2020-10-27T00:00:00"
  },
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetCommunicationMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Communication.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <CommunicationMessage>
    <Channel>Text</Channel>
    <CommunicationMessageId>14123</CommunicationMessageId>
    <ExpirationDateUtc>2020-10-29T00:00:00-07:00</ExpirationDateUtc>
    <LastUpdatedDateUtc>2020-10-27T00:00:00-07:00</LastUpdatedDateUtc>
    <MessageExternalId>3d1daf56-8889-4462-be65-a8b31fba5589</MessageExternalId>
    <MessageStatus>Delivered</MessageStatus>
    <Payload>123</Payload>
    <SendingDateUtc>2020-10-27T00:00:00-07:00</SendingDateUtc>
    <StatusDescription>Success</StatusDescription>
    <Timezone>America/Los_Angeles</Timezone>
  </CommunicationMessage>
  <ExecutionResultDescription i:nil="true" />
</GetCommunicationMessageResponse>

POST api/Messages/SendVerificationCode

Schedule verification code message for send

MethodEndpoint
SendVerificationCode https://stgportalone.processonepayments.com/Communication/api/Messages/SendVerificationCode

SendVerificationCodeRequest

NameDescriptionTypeRequired*Additional information
ExternalMessageId

External MessageId

string Yes
Channel

Communication Message Chanel

CommunicationMessageChannelType Yes
TimezoneId

Time Zone

string No
PhoneNumber

Phone Number. Required if Channel is Text or PhoneCall

string No
EmailAddress

Email Address. Required if Channel is Email

string No
CustomerId

Customer Id. Required if ExternalCustomerId is null or empty

globally unique identifier No
ExternalCustomerId

External Customer Id. Required if CustomerId is null or empty

string No
AccountId

Account Id

string No
Properties

External Properties

Dictionary of string and string No
PortalOneAuthenticationKey

PortalOne Authentication Key

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "ExternalMessageId": "3d1daf56-8889-4462-be65-a8b31fba5589",
  "Channel": 2,
  "TimezoneId": "America/Los_Angeles",
  "PhoneNumber": "19111111111",
  "EmailAddress": null,
  "CustomerId": null,
  "ExternalCustomerId": "789456123",
  "AccountId": null,
  "Properties": {},
  "PortalOneAuthenticationKey": "Authentication Key"
}
                                
                                 <SendVerificationCodeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Communication.Contracts.DataContracts">
  <PortalOneAuthenticationKey>Authentication Key</PortalOneAuthenticationKey>
  <AccountId i:nil="true" />
  <Channel>Text</Channel>
  <CustomerId i:nil="true" />
  <EmailAddress i:nil="true" />
  <ExternalCustomerId>789456123</ExternalCustomerId>
  <ExternalMessageId>3d1daf56-8889-4462-be65-a8b31fba5589</ExternalMessageId>
  <PhoneNumber>19111111111</PhoneNumber>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
  <TimezoneId>America/Los_Angeles</TimezoneId>
</SendVerificationCodeRequest>

Response Information

SendCommunicationMessageResponse

NameDescriptionTypeRequired*Additional information
ExecutionResult

Execution Result

SendCommunicationMessageExecutionResult No
ExecutionResultDescription

Result Description

string No
ResponseCode

Response Code

string No
ResponseMessage

Response Message

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "ExecutionResult": 4,
  "ExecutionResultDescription": null,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<SendCommunicationMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Communication.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <ExecutionResult>Success</ExecutionResult>
  <ExecutionResultDescription i:nil="true" />
</SendCommunicationMessageResponse>

POST api/Messages/ValidateVerificationCode

Validate verification code

MethodEndpoint
ValidateVerificationCode https://stgportalone.processonepayments.com/Communication/api/Messages/ValidateVerificationCode

ValidateVerificationCodeRequest

NameDescriptionTypeRequired*Additional information
ExternalMessageId

External Message Id

string Yes
VerificationCode

Verification Code

string Yes
PortalOneAuthenticationKey

PortalOne Authentication Key

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "ExternalMessageId": "3d1daf56-8889-4462-be65-a8b31fba5589",
  "VerificationCode": "037451",
  "PortalOneAuthenticationKey": "Authentication Key"
}
                                
                                 <ValidateVerificationCodeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Communication.Contracts.DataContracts">
  <PortalOneAuthenticationKey>Authentication Key</PortalOneAuthenticationKey>
  <ExternalMessageId>3d1daf56-8889-4462-be65-a8b31fba5589</ExternalMessageId>
  <VerificationCode>037451</VerificationCode>
</ValidateVerificationCodeRequest>

Response Information

ValidateVerificationCodeResponse

NameDescriptionTypeRequired*Additional information
Result

Validate Verification Code

ValidateVerificationCodeStatus No
RemainingAttemptsCount

Remaining Attempts Count

integer No
ExpirationDate

Expiration Date

date No
ResponseCode

Response Code

string No
ResponseMessage

Response Message

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

ValidateVerificationCodeStatus

Possible enumeration values:

NameValueDescription
NotValid

1

Not Valid Verification Code Status

Locked

2

Locked Verification Code Status

Expired

3

Expired Verification Code Status

Valid

4

Valid Verification Code Status

Response Formats

{
  "Result": 4,
  "RemainingAttemptsCount": 13,
  "ExpirationDate": "2020-10-29T00:00:00",
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<ValidateVerificationCodeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Communication.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <ExpirationDate>2020-10-29T00:00:00-07:00</ExpirationDate>
  <RemainingAttemptsCount>13</RemainingAttemptsCount>
  <Result>Valid</Result>
</ValidateVerificationCodeResponse>

GET api/Messages/IsVerificationCodeValidated?ExternalMessageId={ExternalMessageId}&PhoneNumber={PhoneNumber}&PortalOneAuthenticationKey={PortalOneAuthenticationKey}

Is verification code validated

MethodEndpoint
IsVerificationCodeValidated https://stgportalone.processonepayments.com/Communication/api/Messages/IsVerificationCodeValidated?ExternalMessageId={ExternalMessageId}&PhoneNumber={PhoneNumber}&PortalOneAuthenticationKey={PortalOneAuthenticationKey}

URI Parameters

NameDescriptionTypeRequired*Additional information
ExternalMessageId

External Message Id

string Yes
PhoneNumber

Phone Number

string Yes
PortalOneAuthenticationKey

PortalOne Authentication Key

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

String

Request Formats

 

Response Information

IsVerificationCodeValidatedResponse

NameDescriptionTypeRequired*Additional information
IsValidated

Is Verification Code Validated

boolean No
ResponseCode

Response Code

string No
ResponseMessage

Response Message

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "IsValidated": true,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<IsVerificationCodeValidatedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Communication.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <IsValidated>true</IsValidated>
</IsVerificationCodeValidatedResponse>

MessageTemplates

GET api/MessageTemplates/GetTemplatesInfo?PortalOneAuthenticationKey={PortalOneAuthenticationKey}

Get available template codes in the portal identified by authentication key

MethodEndpoint
GetTemplatesInfo https://stgportalone.processonepayments.com/Communication/api/MessageTemplates/GetTemplatesInfo?PortalOneAuthenticationKey={PortalOneAuthenticationKey}

URI Parameters

NameDescriptionTypeRequired*Additional information
PortalOneAuthenticationKey

PortalOne Authentication Key

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

String

Request Formats

 

Response Information

GetCommunicationTemplateInfoResponse

NameDescriptionTypeRequired*Additional information
TemplatesInfo

Collection of Templates Info

Collection of CommunicationMessageTemplateInfo No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

CommunicationMessageTemplateInfo

NameDescriptionTypeRequired*Additional information
Key

Template Key

string No
Channel

Communication Message Channel

CommunicationMessageChannelType No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "TemplatesInfo": [
    {
      "Key": "Payment_due_today",
      "Channel": 2
    },
    {
      "Key": "Policy_status_change",
      "Channel": 2
    }
  ]
}
<GetCommunicationTemplateInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Communication.Contracts.DataContracts">
  <TemplatesInfo>
    <CommunicationMessageTemplateInfo>
      <Channel>Text</Channel>
      <Key>Payment_due_today</Key>
    </CommunicationMessageTemplateInfo>
    <CommunicationMessageTemplateInfo>
      <Channel>Text</Channel>
      <Key>Policy_status_change</Key>
    </CommunicationMessageTemplateInfo>
  </TemplatesInfo>
</GetCommunicationTemplateInfoResponse>

Subscriptions

POST api/Subscriptions/GetSubscriptionDetails

Get subscription statuses by phone number/email/customer id/external customer id

MethodEndpoint
GetSubscriptionDetails https://stgportalone.processonepayments.com/Communication/api/Subscriptions/GetSubscriptionDetails

GetSubscriptionDetailsRequest

NameDescriptionTypeRequired*Additional information
PhoneNumberList

Collection of Phone Numbers

Collection of string No
EmailList

Collection of Email Addresses

Collection of string No
CustomerIdList

Collection of Customer Id

Collection of globally unique identifier No
ExternalCustomerIdList

Collection of External Customer ID

Collection of string No
PortalOneAuthenticationKey

PortalOne Authentication Key

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "PhoneNumberList": [
    "19111111111",
    "29222222222",
    "39333333333"
  ],
  "EmailList": [
    "[email protected]"
  ],
  "CustomerIdList": [
    "f1714167-33ff-4fb0-8b5c-e0e3b5e91d95"
  ],
  "ExternalCustomerIdList": [
    "789456123"
  ],
  "PortalOneAuthenticationKey": "Authentication Key"
}
                                
                                 <GetSubscriptionDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Communication.Contracts.DataContracts">
  <PortalOneAuthenticationKey>Authentication Key</PortalOneAuthenticationKey>
  <CustomerIdList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>f1714167-33ff-4fb0-8b5c-e0e3b5e91d95</d2p1:guid>
  </CustomerIdList>
  <EmailList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>[email protected]</d2p1:string>
  </EmailList>
  <ExternalCustomerIdList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>789456123</d2p1:string>
  </ExternalCustomerIdList>
  <PhoneNumberList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>19111111111</d2p1:string>
    <d2p1:string>29222222222</d2p1:string>
    <d2p1:string>39333333333</d2p1:string>
  </PhoneNumberList>
</GetSubscriptionDetailsRequest>

Response Information

GetSubscriptionDetailsResponse

NameDescriptionTypeRequired*Additional information
SubscriptionDetailsList

Collection of Subscription Details

Collection of SubscriptionDetailsDto No
ResponseCode

Response Code

string No
ResponseMessage

Response Message

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

SubscriptionDetailsDto

NameDescriptionTypeRequired*Additional information
CustomerId

Customer Id

globally unique identifier No
ExternalCustomerId

External Customer Id

string No
TextSubscriptionStatus

Subscription Detail Status for Text Messages

SubscriptionDetailsStatus No
TextSubscriptionContact

Text Subscription Contact

string No
EmailSubscriptionStatus

Subscription Detail Status for Email Messages

SubscriptionDetailsStatus No
EmailSubscriptionContact

Email Subscription Contact

string No
PhoneCallSubscriptionStatus

Subscription Detail Status for Phone Call

SubscriptionDetailsStatus No
PhoneCallSubscriptionContact

Phone Call Subscription Contact

string No
ResultCode

Result Code

string No
ResultMessage

Result Message

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

SubscriptionDetailsStatus

Possible enumeration values:

NameValueDescription
NotEnrolled

0

Subscription Detail Not Enrolled

OptedIn

1

Subscription Detail OptedIn

OptedOut

2

Subscription Detail OptedOut

AwaitingOptIn

3

Subscription Detail Awaiting OptIn

Response Formats

{
  "SubscriptionDetailsList": [
    {
      "CustomerId": "f1714167-33ff-4fb0-8b5c-e0e3b5e91d95",
      "ExternalCustomerId": null,
      "TextSubscriptionStatus": 1,
      "TextSubscriptionContact": "19111111111",
      "EmailSubscriptionStatus": 1,
      "EmailSubscriptionContact": "[email protected]",
      "PhoneCallSubscriptionStatus": 0,
      "PhoneCallSubscriptionContact": null,
      "ResultCode": "Success",
      "ResultMessage": null
    },
    {
      "CustomerId": "a6d3318d-8d98-4608-9b75-2e92122c2b5e",
      "ExternalCustomerId": "789456123",
      "TextSubscriptionStatus": 1,
      "TextSubscriptionContact": "29222222222",
      "EmailSubscriptionStatus": 0,
      "EmailSubscriptionContact": null,
      "PhoneCallSubscriptionStatus": 1,
      "PhoneCallSubscriptionContact": "29222222222",
      "ResultCode": "Success",
      "ResultMessage": null
    }
  ],
  "ResponseCode": null,
  "ResponseMessage": null
}
<GetSubscriptionDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.Communication.Contracts.DataContracts">
  <ResponseCode i:nil="true" />
  <ResponseMessage i:nil="true" />
  <SubscriptionDetailsList>
    <SubscriptionDetailsDto>
      <CustomerId>f1714167-33ff-4fb0-8b5c-e0e3b5e91d95</CustomerId>
      <EmailSubscriptionContact>[email protected]</EmailSubscriptionContact>
      <EmailSubscriptionStatus>OptedIn</EmailSubscriptionStatus>
      <ExternalCustomerId i:nil="true" />
      <PhoneCallSubscriptionContact i:nil="true" />
      <PhoneCallSubscriptionStatus>NotEnrolled</PhoneCallSubscriptionStatus>
      <ResultCode>Success</ResultCode>
      <ResultMessage i:nil="true" />
      <TextSubscriptionContact>19111111111</TextSubscriptionContact>
      <TextSubscriptionStatus>OptedIn</TextSubscriptionStatus>
    </SubscriptionDetailsDto>
    <SubscriptionDetailsDto>
      <CustomerId>a6d3318d-8d98-4608-9b75-2e92122c2b5e</CustomerId>
      <EmailSubscriptionContact i:nil="true" />
      <EmailSubscriptionStatus>NotEnrolled</EmailSubscriptionStatus>
      <ExternalCustomerId>789456123</ExternalCustomerId>
      <PhoneCallSubscriptionContact>29222222222</PhoneCallSubscriptionContact>
      <PhoneCallSubscriptionStatus>OptedIn</PhoneCallSubscriptionStatus>
      <ResultCode>Success</ResultCode>
      <ResultMessage i:nil="true" />
      <TextSubscriptionContact>29222222222</TextSubscriptionContact>
      <TextSubscriptionStatus>OptedIn</TextSubscriptionStatus>
    </SubscriptionDetailsDto>
  </SubscriptionDetailsList>
</GetSubscriptionDetailsResponse>