Status da mensagem

Consulta status/delivery de uma mensagem enviada pela API pública. Requer scope messages:read. Consome bucket read.

GET https://api.aideskbr.com/api/public/v1/messages/{messageId}

Status da mensagem

cURL

curl --request GET \
  --url https://api.aideskbr.com/api/public/v1/messages/{messageId} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.aideskbr.com/api/public/v1/messages/{messageId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.aideskbr.com/api/public/v1/messages/{messageId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "client_message_id": "<string>",
  "type": "<string>",
  "direction": "<string>",
  "delivery_state": "<string>",
  "channel_kind": "<string>",
  "body": "<string>",
  "provider_error_code": "<string>",
  "provider_error_detail": "<string>",
  "sent_at": "2023-11-07T05:31:56Z",
  "delivery_updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "api_key_required",
    "message": "API key ausente"
  }
}

{
  "error": {
    "code": "missing_scope",
    "message": "Scope insuficiente"
  }
}

{
  "error": {
    "code": "message_not_found",
    "message": "Mensagem não encontrada"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded"
  }
}

Authorizations

bearerAuthapiKeyAuth

Authorization · string · header · required

Authorization: Bearer ak_live_

Path Parameters

messageId · string<uuid> · required

Response

200

application/json

Mensagem encontrada

message_id · string<uuid> · required

thread_id · string<uuid> · required

contact_id · string<uuid> · required

channel_id · string<uuid> · required

client_message_id · string · required

type · string · required

direction · string · required

Example:

"outbound"

delivery_state · string · required

channel_kind · string

Example:

"whatsapp"

body · string | null

provider_error_code · string | null

provider_error_detail · string | null

sent_at · string<date-time> | null

delivery_updated_at · string<date-time> | null