Messages

Submit an inbound message

Submit a message written by one of your users and let the Shortext agent answer it.

Reply modes

sync: the request waits for the agent reply (max ~25 s) and returns it in body.replies. On timeout body.status is pending and the reply is delivered to your webhook.
async: the request returns immediately with accepted; replies are delivered to your webhook.

Idempotency: message.id is your own message id. Sending the same id again returns duplicate with the original message, without a second reply.

Webhook: replies (async, sync timeout, human agent answers) are POSTed to the endpoint webhook as message.sent events (ShortextWebhookEvent body), signed with X-Shortext-Signature: sha256=hex(hmac_sha256(secret, "{X-Shortext-Timestamp}.{raw_body}")). Retried for ~21 h on failure; dedupe on the event id.

POST

v1.0

messages

inbound

Submit an inbound message

curl --request POST \
  --url https://shortext.ny-corp.io/api/v1.0/messages/inbound \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": "shortext",
  "to": "ste_8k2m4q9x1v7c3n5b6z0p2r4t",
  "contact": {
    "identifier": "user-42",
    "profile": {
      "lastname": "Awa",
      "firstname": "<string>",
      "email": "jsmith@example.com"
    }
  },
  "message": {
    "id": "client-msg-001",
    "type": "text",
    "content": {
      "text": "Ceci est un message texte.",
      "preview_url": true
    },
    "metadata": {
      "page": "/checkout"
    }
  },
  "reply_mode": "sync"
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://shortext.ny-corp.io/api/v1.0/messages/inbound",
  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' => 'shortext',
    'to' => 'ste_8k2m4q9x1v7c3n5b6z0p2r4t',
    'contact' => [
        'identifier' => 'user-42',
        'profile' => [
                'lastname' => 'Awa',
                'firstname' => '<string>',
                'email' => 'jsmith@example.com'
        ]
    ],
    'message' => [
        'id' => 'client-msg-001',
        'type' => 'text',
        'content' => [
                'text' => 'Ceci est un message texte.',
                'preview_url' => true
        ],
        'metadata' => [
                'page' => '/checkout'
        ]
    ],
    'reply_mode' => 'sync'
  ]),
  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: 'shortext',
    to: 'ste_8k2m4q9x1v7c3n5b6z0p2r4t',
    contact: {
      identifier: 'user-42',
      profile: {lastname: 'Awa', firstname: '<string>', email: 'jsmith@example.com'}
    },
    message: {
      id: 'client-msg-001',
      type: 'text',
      content: {text: 'Ceci est un message texte.', preview_url: true},
      metadata: {page: '/checkout'}
    },
    reply_mode: 'sync'
  })
};

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

import requests

url = "https://shortext.ny-corp.io/api/v1.0/messages/inbound"

payload = {
    "channel": "shortext",
    "to": "ste_8k2m4q9x1v7c3n5b6z0p2r4t",
    "contact": {
        "identifier": "user-42",
        "profile": {
            "lastname": "Awa",
            "firstname": "<string>",
            "email": "jsmith@example.com"
        }
    },
    "message": {
        "id": "client-msg-001",
        "type": "text",
        "content": {
            "text": "Ceci est un message texte.",
            "preview_url": True
        },
        "metadata": { "page": "/checkout" }
    },
    "reply_mode": "sync"
}
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": {
    "status": "completed",
    "message": {
      "id": "msg.Xk29aB",
      "conversation_id": "cnv.7Hq2Lm",
      "direction": "inbound",
      "channel": "shortext",
      "channel_id": "ste_8k2m4q9x1v7c3n5b6z0p2r4t",
      "contact": {
        "identifier": "user-42",
        "identifier_type": "external_id",
        "profile": {
          "lastname": "Awa",
          "firstname": "<string>",
          "email": "<string>",
          "preferred_language": "fr"
        },
        "country": {}
      },
      "message": {
        "id": "client-msg-001",
        "type": "text",
        "content": {
          "text": "Oui, nous livrons à Douala."
        }
      },
      "status": "sent",
      "created_at": "2023-11-07T05:31:56Z"
    },
    "replies": [
      {
        "id": "msg.Xk29aB",
        "conversation_id": "cnv.7Hq2Lm",
        "direction": "inbound",
        "channel": "shortext",
        "channel_id": "ste_8k2m4q9x1v7c3n5b6z0p2r4t",
        "contact": {
          "identifier": "user-42",
          "identifier_type": "external_id",
          "profile": {
            "lastname": "Awa",
            "firstname": "<string>",
            "email": "<string>",
            "preferred_language": "fr"
          },
          "country": {}
        },
        "message": {
          "id": "client-msg-001",
          "type": "text",
          "content": {
            "text": "Oui, nous livrons à Douala."
          }
        },
        "status": "sent",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "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.

Corps

application/json

channel

enum<string>

requis

Only native channels accept inbound messages

Options disponibles:

shortext

Exemple:

"shortext"

string

requis

Endpoint ID shown in the Shortext dashboard

Exemple:

"ste_8k2m4q9x1v7c3n5b6z0p2r4t"

contact

object

requis

Show child attributes

message

object

requis

Show child attributes

reply_mode

enum<string>

Defaults to the endpoint setting

Options disponibles:

sync,

async

Exemple:

"sync"

Réponse

200 - application/json

Message stored. See body.status for the reply outcome.

Envelope of every response (always HTTP 200): only body changes from one endpoint to another.

success

boolean

requis

Exemple:

true

code

enum<integer>

requis

Standard response codes defined by the system / Codes de réponse standard définis par le système.

Options disponibles:

-1,

-2,

-3,

-4,

-5,

1000,

-1001,

-1002,

-1003,

-1004,

-1005,

-1006,

-1007,

-1008,

-1009,

-1010,

-1100,

-1101,

-1102,

-1103,

1104,

-1105

Exemple:

1000

message

string

requis

Exemple:

"Request success"

body

object

Endpoint-specific payload, null on most errors

Show child attributes

token

string | null

Present only on authentication routes

trace_id

string | null

Present only when success=false. Give it to support.

Submit an inbound message

curl --request POST \
  --url https://shortext.ny-corp.io/api/v1.0/messages/inbound \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": "shortext",
  "to": "ste_8k2m4q9x1v7c3n5b6z0p2r4t",
  "contact": {
    "identifier": "user-42",
    "profile": {
      "lastname": "Awa",
      "firstname": "<string>",
      "email": "jsmith@example.com"
    }
  },
  "message": {
    "id": "client-msg-001",
    "type": "text",
    "content": {
      "text": "Ceci est un message texte.",
      "preview_url": true
    },
    "metadata": {
      "page": "/checkout"
    }
  },
  "reply_mode": "sync"
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://shortext.ny-corp.io/api/v1.0/messages/inbound",
  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' => 'shortext',
    'to' => 'ste_8k2m4q9x1v7c3n5b6z0p2r4t',
    'contact' => [
        'identifier' => 'user-42',
        'profile' => [
                'lastname' => 'Awa',
                'firstname' => '<string>',
                'email' => 'jsmith@example.com'
        ]
    ],
    'message' => [
        'id' => 'client-msg-001',
        'type' => 'text',
        'content' => [
                'text' => 'Ceci est un message texte.',
                'preview_url' => true
        ],
        'metadata' => [
                'page' => '/checkout'
        ]
    ],
    'reply_mode' => 'sync'
  ]),
  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: 'shortext',
    to: 'ste_8k2m4q9x1v7c3n5b6z0p2r4t',
    contact: {
      identifier: 'user-42',
      profile: {lastname: 'Awa', firstname: '<string>', email: 'jsmith@example.com'}
    },
    message: {
      id: 'client-msg-001',
      type: 'text',
      content: {text: 'Ceci est un message texte.', preview_url: true},
      metadata: {page: '/checkout'}
    },
    reply_mode: 'sync'
  })
};

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

import requests

url = "https://shortext.ny-corp.io/api/v1.0/messages/inbound"

payload = {
    "channel": "shortext",
    "to": "ste_8k2m4q9x1v7c3n5b6z0p2r4t",
    "contact": {
        "identifier": "user-42",
        "profile": {
            "lastname": "Awa",
            "firstname": "<string>",
            "email": "jsmith@example.com"
        }
    },
    "message": {
        "id": "client-msg-001",
        "type": "text",
        "content": {
            "text": "Ceci est un message texte.",
            "preview_url": True
        },
        "metadata": { "page": "/checkout" }
    },
    "reply_mode": "sync"
}
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": {
    "status": "completed",
    "message": {
      "id": "msg.Xk29aB",
      "conversation_id": "cnv.7Hq2Lm",
      "direction": "inbound",
      "channel": "shortext",
      "channel_id": "ste_8k2m4q9x1v7c3n5b6z0p2r4t",
      "contact": {
        "identifier": "user-42",
        "identifier_type": "external_id",
        "profile": {
          "lastname": "Awa",
          "firstname": "<string>",
          "email": "<string>",
          "preferred_language": "fr"
        },
        "country": {}
      },
      "message": {
        "id": "client-msg-001",
        "type": "text",
        "content": {
          "text": "Oui, nous livrons à Douala."
        }
      },
      "status": "sent",
      "created_at": "2023-11-07T05:31:56Z"
    },
    "replies": [
      {
        "id": "msg.Xk29aB",
        "conversation_id": "cnv.7Hq2Lm",
        "direction": "inbound",
        "channel": "shortext",
        "channel_id": "ste_8k2m4q9x1v7c3n5b6z0p2r4t",
        "contact": {
          "identifier": "user-42",
          "identifier_type": "external_id",
          "profile": {
            "lastname": "Awa",
            "firstname": "<string>",
            "email": "<string>",
            "preferred_language": "fr"
          },
          "country": {}
        },
        "message": {
          "id": "client-msg-001",
          "type": "text",
          "content": {
            "text": "Oui, nous livrons à Douala."
          }
        },
        "status": "sent",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "token": "<string>",
  "trace_id": "<string>"
}

API historique

Endpoints

Submit an inbound message

Autorisations

Corps

Réponse