View Message

View Message

GET https://api.ocamba.com/v1/hood/messages/{id}
Retrieves the details of a Message that has previously been created if a valid identifier was provided

Rate limits:

  • Burst: 10/s
  • Steady: 150/m

Path parameters

parameters

Query parameters

parameters

Response schemas

curl -X GET \
 "https://api.ocamba.com/v1/hood/messages/{id}" \
  -H "Authorization: Bearer {TOKEN}"
const url = 'https://api.ocamba.com/v1/hood/messages/{id}';
const options = {
  method: 'GET',
  headers: {
    Authorization: `Bearer {TOKEN}`
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
$ch = curl_init("https://api.ocamba.com/v1/hood/messages/{id}");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer {TOKEN}"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Responses

200 OK

{
  "total": 1,
  "items": [
    {
      "id": "1",
      "company_id": "123456",
      "name": "my_msg",
      "title": {
        "en": "en_title"
      },
      "body": {
        "en": "en_body"
      },
      "image": {
        "en": "https://example.com"
      },
      "landing_url": "https://example.com",
      "actions": [
        {
          "title": {
            "en": "Yes"
          },
          "icon": "https://example.com",
          "url": "https://example.com"
        },
        {
          "title": {
            "en": "No"
          },
          "icon": "https://example.com"
        }
      ],
      "create_time": "2021-11-10 12:53:58"
    }
  ]
}

400 Bad Request

{
  "code": 400,
  "title": "Bad request.",
  "message": "The request body is not valid.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

500 Internal Server Error

{
  "code": 500,
  "title": "Internal server error.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}
Responses
Tip
If you don’t know the message id, list the messages to find it.