Call Hangup API - Number Masking

This API allows clients to terminate an actively running Number Masking call on Alohaa with a unique Call ID specific to their organization.

Endpoint Description

POST https://number-masking.alohaa.ai/v1/external/call/hangup

Parameters

Request Headers

Field	Value	Description	Mandatory
Content-Type	application/json	Specifies the content type of the request.	Yes
x-metro-api-key	*************************	API key for authentication purposes.	Yes

Request Body

Field	Data Type	Description	Mandatory
call_id	string	Unique identifier of the call	Yes

Good to know: "call_id" is a unique ID shared with the client when Alohaa servers send an API request for a receiver number.

Sample Request

Request Header

{
  "x-metro-api-key": "****************"
}

Request Body

{
  "call_id": "e1ffd143-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Responses

Success Response

{
  "success": true,
  "response": {
    "call_id": "e1ffd143-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  }
}

Failure Response

{
  "success": false,
  "error": {
    "code": 1040,
    "reason": "Call details not found"
  }
}

Error Codes

Code
1000	Internal Server Error. Something went wrong!
1002	Invalid api key id
1009	Invalid schema or Missing Data sent
1040	There is not active call running with the referenced call_id