Get conversation assignment

Returns which team member is handling a conversation and its status (open, pending or closed). A conversation that was never assigned or given a status is reported as unassigned and open. Team users need API access and the conversation permission.

Base URL:

GET: https://api.smsgatewayapi.com/v1/conversations/{key}/assignment

Example:

GET: https://api.smsgatewayapi.com/v1/conversations/32470123456/assignment

Parameter	Input	Description
client_id	API client ID	Developer › API & Webhooks › API credentials	Required
client_secret	API client secret	A `cs_` credential, shown once when you create it under Developer › API & Webhooks › API credentials	Required
key	conversation key	The conversation as shown in your conversation list: a phone number in international format (e.g. 32470123456), a WhatsApp user ID for a user without phone number (BE.… for WhatsApp Business, WA.LID… for WhatsApp Web) or group:gid_… for a group conversation (the numeric group ID is accepted too). Group keys are always returned with the public group ID.	Required

<?php
	//PHP - cURL
	$ch = curl_init();
	$url = "https://api.smsgatewayapi.com/v1/conversations/{key}/assignment";
	$client_id = "XXX"; // Your API client ID (required)
	$client_secret = "YYY"; // Your API client secret (required)
	

	curl_setopt($ch, CURLOPT_URL, "$url");
	curl_setopt($ch, CURLOPT_POST, false);
	curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
	curl_setopt($ch, CURLOPT_VERBOSE, true);
	curl_setopt($ch, CURLOPT_HTTPHEADER, [
		"X-Client-Id: $client_id",
		"X-Client-Secret: $client_secret",
		"Content-Type: application/json",
	]);
	$response = curl_exec($ch);
?>

//NodeJs - HTTP request			
const https = require("https");
const client_id = "XXX"; // Your API client ID (required)
const client_secret = "YYY"; // Your API client secret (required)
const options = {
    hostname: "api.smsgatewayapi.com",
    port: 443,
    path: "/v1/conversations/{key}/assignment",
    method: "GET",
    headers: {
        "X-Client-Id": client_id,
        "X-Client-Secret": client_secret,
    },
};
const req = https.request(options, (res) => {
    console.log(`statusCode: ${res.statusCode}`);
    res.on("data", (d) => {
        process.stdout.write(d);
    });
});
req.write(data);
req.end();

//Ruby - Net::HTTP			
require "uri"
require "net/http"

url = URI("https://api.smsgatewayapi.com/v1/conversations/{key}/assignment")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Client-Id"] = "XXX" // Your API key
request["X-Client-Secret"] = "YYY" // Your API secret
response = https.request(request)
puts response.read_body

//Python - Requests			
import requests
url = "https://api.smsgatewayapi.com/v1/conversations/{key}/assignment"
payload={
}
headers = {
	'X-Client-Id': 'XXX', #Your API key
	'X-Client-Secret': 'YYY', #Your API secret
	'Content-Type': 'application/json'
}
response = requests.request(
	"GET",
	url,
	headers=headers,
	json=payload
)
print(response.text)

//PowerShell - RestMethod
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("X-Client-Id", "XXX") // Your API key
$headers.Add("X-Client-Secret", "YYY") // Your API secret

$body = '{
}'

$response = Invoke-RestMethod 'https://api.smsgatewayapi.com/v1/conversations/{key}/assignment' -Method 'GET' -Headers $headers -Body $body -ContentType “application/json; charset=utf-8”
$response | ConvertTo-Json

//Shell - wget
wget --no-check-certificate --quiet \
  --method GET \
  --timeout=0 \
  --header 'X-Client-Id: XXX' \ // Your API key
  --header 'X-Client-Secret: YYY' \ // Your API secret
  --header 'Content-Type: application/json' \
  --body-data '{
}' \
   'https://api.smsgatewayapi.com/v1/conversations/{key}/assignment'

Example success response:

{
	"conversation_key": "32470123456",
	"assignee": {
		"public_id": "sub_3520a1ec234dbabe1232def67e858855",
		"name": "alice"
	},
	"status": "open",
	"assigned_at": "2026-09-07 10:15:00"
}

assignee is null when nobody is assigned; name is the username of the team member (see List subaccounts).

Example error response:

{
	"error": 145,
	"errorMsg": "Invalid conversation key [group:]"
}

API

Guides

Messages

Voice

WhatsApp Business

Groups

Contacts

Outbox

Account

Sender IDs

Teammate/Subaccount

Conversations

Workflows

Message Templates

Birthday Message

Opt-out

Other

Webhooks (v2)

Get conversation assignment

SMS API

REGISTER NOW