uaCSTA - Refuse a Call

Prerequisites

To perform the uaCSTA control operations for IP phones, make sure the following requirements are met.

Your IP phone model and firmware version work for Yeastar uaCSTA
The uaCSTA feature on your IP phone is enabled. Refer to the following topics:
- How to enable uaCSTA feature of Yealink IP phones
- How to enable uaCSTA feature of Fanvil IP phones
The uaCSTA feature on the PBX is enabled (Path: Settings > PBX > General > SIP > Advanced > Enable uaCSTA connection).

Request URL

{base_url}/{api_path}/uacstacall/refuse_inbound?token={token}

Request parameters


Parameter	Required	Type	Description
extnumber	Yes	String	The extension number that you want to control.
cstacallid	Yes	Integer	The unique ID of each uaCSTA call. When the uaCSTA feature is enabled, the system will automatically assign a `cstacallid` to each call. Note: You can acquire the `cstacallid` from the uacstacall event.
ipaddress	Yes	String	The IP address of the IP phone where the extension is registered.

Response parameters


Parameter	Type	Description
status	String	Request result. Success Failed

Examples

Request example

POST /api/v2.0.0/uacstacall/refuse_inbound?token=38a0563849a15cd7187b835d1acbf5a5 HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150
{
  "extnumber":"1000",
  "cstacallid":"32785",
  "ipaddress":"192.168.66.70:5060"
 }

Response example

HTTP/1.1 200 OK
Date: Wed, 19 May 2021 08:06:22 GMT
Server: Boa/0.94.101wk
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
  "status":"Success"
 }