Search Interactions

get

https://api.talkdeskapp.com/automated-notifications/interactions

Retrieves a list of the Automated Notifications Interactions searched by query parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

automated-notifications-interactions:read

Query Params

event_id

string

length ≥ 1

The Automated Notifications event ID.

rule_id

string

length ≥ 1

The Automated Notifications rule ID.

external_id

string

length ≥ 1

The external flow ID.

external_type_id

string

length ≥ 1

The external flow ID type.

escalation_id

string

length ≥ 1

The Interactions escalation ID.

escalation_state

string

length ≥ 1

The Interactions escalation state.

contact_id

string

length ≥ 1

The contact id, talkdesk contact api id with whom the messages are being exchanged.

channel_type

string

length ≥ 1

The Interactions channel type (SMS, EMAIL).

an_channel_uri

string

length ≥ 1

The automated-notifications interaction channel uri, the talkdesk phone number for outbound messages.

contact_channel_uri

string

length ≥ 1

The contact phone number for inbound messages.

state

string

length ≥ 1

Automated notification interaction state. The initial state, when the interaction starts, is 'OPEN'.

start_date

string

length ≥ 1

Automated notification interaction start date.

end_date

string

length ≥ 1

Automated notification interaction end date.

last_updated

string

length ≥ 1

Automated notification interaction last updated date.

skip

int32

0 to 2147483647

Defaults to 0

The start index to fetch the members.

limit

int32

1 to 100

Defaults to 50

The total amount of members to be fetched.

order_by

string

1 to 50

Defaults to startDate:asc

The sort mechanism.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Scope

200OK

400Bad Request

401Unauthorized

403Forbidden