Release conversation
Removes the assignee of a conversation; its status is kept. This is the same as Assign conversation
with team_member null.
Base URL:
DELETE: https://api.smsgatewayapi.com/v1/conversations/{key}/assignmentExample:
DELETE: 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, 'DELETE');
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);
?>
Example success response:
{
"conversation_key": "32470123456",
"assignee": null,
"status": "open",
"assigned_at": null
}
Example error response:
{
"error": 128,
"errorMsg": "Group [gid_...] not found"
}
