The Get conversation endpoint returns information for a single messaging conversation.

Requirements: Base URL, Authentication, Error codes

Scope: messaging.conversations.read

What this does

When you send a Get conversation request with a conversation ID,

When to use it

• Retrieve a conversation after you have its ID from Get list of conversations
• Display conversation context in an external system before retrieving messages
• Validate that a conversation exists and is accessible to your API key

Prerequisites

• The conversation must exist in the contact center.
• You must have access to the conversation.

Endpoint

GET /api/v4/messaging/conversations/{conversation_id}

Path parameters

• conversation_id
  The unique identifier of the conversation (UUID).

Examples

Minimal request

curl -X GET "https://{cluster_id}.voiso.com/api/v4/messaging/conversations/0b62763c-40d6-4ec8-8380-3cb94e442a75" \
  -H "Authorization: Bearer <contact_center_api_key>" \
  -H "Content-Type: application/json"

Response

If successful, the API returns a conversation object.

{
  "conversation": {
    "id": "0b62763c-40d6-4ec8-8380-3cb94e442a75",
    "channel_profile": {
      "id": 12,
      "channel": "whatsapp",
      "identifier": "18885658889",
      "name": "WhatsApp Main (18885658889)"
    },
    "contact_channel_account": {
      "id": "0b62763c-40d6-4ec8-8380-3cb94e442a75",
      "channel": "whatsapp",
      "identifier": "15551234567",
      "data": {
        "name": "John Smith",
        "username": "johnsmith"
      }
    },
    "user": {
      "id": "0b97ce11-b6e0-49b4-8f92-68040aa324bf",
      "name": "Jane Doe",
      "email": "[email protected]"
    },
    "flow": {
      "id": "0b62763c-40d6-4ec8-8380-3cb94e442a75",
      "name": "Lead Qualification"
    },
    "queue": {
      "id": 1,
      "name": "Technical Support"
    },
    "status": "active"
  }
}

Notes

• Use the conversation id with the conversation messages endpoint to retrieve the message history for the conversation.

Troubleshooting

401 Unauthorized

What to check:

• You are sending Authorization: Bearer <contact_center_api_key>.
• Your Base URL includes the correct {cluster_id}.

403 Forbidden

What to check:

• The API key is valid, but does not have access to this conversation.

404 Not found

This usually means the conversation ID does not exist, or you do not have access to it.

What to check:

• Confirm the ID using Get list of conversations.

Example response:

{ "error": "Not found" }

429 Too many requests

What to do:

• Reduce request frequency and retry with backoff.