List conversations - Shortext

GET

/

conversations

List conversations

curl --request GET \
  --url https://shortext.ny-corp.io/api/v2.0/conversations \
  --header 'Authorization: Bearer <token>'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://shortext.ny-corp.io/api/v2.0/conversations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://shortext.ny-corp.io/api/v2.0/conversations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "code": 1000,
  "message": "Request success.",
  "body": {
    "current_page": 1,
    "data": [
      {
        "id": "<string>",
        "status": "active",
        "channel": {
          "type": "whatsapp",
          "id": "<string>"
        },
        "agent": {
          "id": "<string>",
          "name": "<string>"
        },
        "contact": {
          "identifier": "<string>",
          "identifier_type": "<string>",
          "profile": {},
          "country": {}
        },
        "session": {
          "started_at": "2023-11-07T05:31:56Z",
          "ends_at": "2023-11-07T05:31:56Z",
          "handover": true,
          "handover_at": "2023-11-07T05:31:56Z",
          "assignee": {
            "id": "USR-XXXXX",
            "name": "<string>"
          }
        },
        "last_message_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "per_page": 50,
    "total": 120,
    "last_page": 3,
    "from": 123,
    "to": 123,
    "first_page_url": "<string>",
    "last_page_url": "<string>",
    "next_page_url": "<string>",
    "prev_page_url": "<string>",
    "path": "<string>"
  },
  "token": "<string>",
  "trace_id": "<string>"
}

Autorisations

Authorization

string

header

requis

Company API key, sent as Authorization: Bearer <key>. Create it in the dashboard (Developer > API Keys) with the permissions the integration needs.

Paramètres de requête

page

integer

status

enum<string>

Options disponibles:

active,

archived

agent_id

string

Conversations of this agent's channels; "none" for detached channels

channel

enum<string>

Channel type

Options disponibles:

whatsapp,

mail,

shortext

channel_id

string

With channel: one channel (the channel_id of the webhooks)

contact

string

Contact identifier (phone, email, or your own id for Shortext)

assignee

string

"me" (user tokens only), "none", or a member id (GET /conversations/assignees)

ticket_id

string

The conversation of a ticket (ticket reference)

updated_since

string<date-time>

Last message at or after this date

Réponse

200 - application/json

Always HTTP 200: the outcome is in success and code (absolute value of the response code).

success

boolean

Exemple:

true

code

integer

Exemple:

1000

message

string

Exemple:

"Request success."

body

object

A page of results: data holds the items. Ask another page with ?page=

Show child attributes

token

string | null

Present only on authentication routes

trace_id

string | null

Present only when success is false

List conversations

curl --request GET \
  --url https://shortext.ny-corp.io/api/v2.0/conversations \
  --header 'Authorization: Bearer <token>'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://shortext.ny-corp.io/api/v2.0/conversations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://shortext.ny-corp.io/api/v2.0/conversations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "code": 1000,
  "message": "Request success.",
  "body": {
    "current_page": 1,
    "data": [
      {
        "id": "<string>",
        "status": "active",
        "channel": {
          "type": "whatsapp",
          "id": "<string>"
        },
        "agent": {
          "id": "<string>",
          "name": "<string>"
        },
        "contact": {
          "identifier": "<string>",
          "identifier_type": "<string>",
          "profile": {},
          "country": {}
        },
        "session": {
          "started_at": "2023-11-07T05:31:56Z",
          "ends_at": "2023-11-07T05:31:56Z",
          "handover": true,
          "handover_at": "2023-11-07T05:31:56Z",
          "assignee": {
            "id": "USR-XXXXX",
            "name": "<string>"
          }
        },
        "last_message_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "per_page": 50,
    "total": 120,
    "last_page": 3,
    "from": 123,
    "to": 123,
    "first_page_url": "<string>",
    "last_page_url": "<string>",
    "next_page_url": "<string>",
    "prev_page_url": "<string>",
    "path": "<string>"
  },
  "token": "<string>",
  "trace_id": "<string>"
}