Start a conversation

curl --request POST \
  --url https://shortext.ny-corp.io/api/v2.0/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel_id": "<string>",
  "contact": {
    "identifier": "<string>",
    "profile": {
      "lastname": "<string>",
      "firstname": "<string>",
      "email": "<string>"
    }
  },
  "message": {
    "content": {
      "text": "Hello, how can I help?"
    }
  },
  "handover": false
}
'

<?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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'channel_id' => '<string>',
    'contact' => [
        'identifier' => '<string>',
        'profile' => [
                'lastname' => '<string>',
                'firstname' => '<string>',
                'email' => '<string>'
        ]
    ],
    'message' => [
        'content' => [
                'text' => 'Hello, how can I help?'
        ]
    ],
    'handover' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    channel_id: '<string>',
    contact: {
      identifier: '<string>',
      profile: {lastname: '<string>', firstname: '<string>', email: '<string>'}
    },
    message: {content: {text: 'Hello, how can I help?'}},
    handover: false
  })
};

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));

import requests

url = "https://shortext.ny-corp.io/api/v2.0/conversations"

payload = {
    "channel_id": "<string>",
    "contact": {
        "identifier": "<string>",
        "profile": {
            "lastname": "<string>",
            "firstname": "<string>",
            "email": "<string>"
        }
    },
    "message": { "content": { "text": "Hello, how can I help?" } },
    "handover": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "code": 1000,
  "message": "Request success.",
  "body": {
    "conversation": {
      "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"
    },
    "message": {
      "id": "msg.XXXXX",
      "conversation_id": "<string>",
      "direction": "inbound",
      "channel": "whatsapp",
      "channel_id": "<string>",
      "contact": {},
      "message": {
        "id": "<string>",
        "type": "text",
        "content": {
          "text": "Hello"
        }
      },
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  },
  "token": "<string>",
  "trace_id": "<string>"
}