All Products
Search
Document Center

:WhatsappCall

Last Updated:Feb 02, 2026

Place, answer, and end WhatsApp voice calls.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

CustSpaceId

string

Yes

The SpaceId or instance ID of the ISV sub-customer. This is the channel ID. View it on the page or the Channel Management page.

cams-xx**

CallId

string

No

The call ID.

wamid-xx**

CallAction

string

Yes

The call action.

Valid values:

  • reject :

    reject

  • terminate :

    terminate

  • pre_accept :

    pre_accept

  • connect :

    connect

  • accept :

    accept

connect

BusinessNumber

string

Yes

The business number.

86138***

UserNumber

string

No

The user's number.

86131***

Session

object

No

The call negotiation information.

SdpType

string

No

The SDP type.

Valid values:

  • offer :

    offer

  • answer :

    answer

offer

Sdp

string

No

The SDP.

v=0\r\no=- 3978582128 3978582128 IN IP4 0.0.0.0\r\ns=Kurento Media Server\r\nc=IN IP4 0.0.0.0\r\nt=0 0\r\na=group:BUNDLE audio0\r\nm=audio 61903 RTP/SAVPF 96 0 8\r\na=setup:actpass\r\na=extmap:3 http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time\r\na=rtpmap:96 opus/48000/2\r\na=rtcp:9 IN IP4 0.0.0.0\r\na=rtcp-mux\r\na=sendrecv\r\na=mid:audio0\r\na=ssrc:1935711036 cname:user3617531270@host-126a650\r\na=ice-ufrag:/TW8\r\na=ice-pwd:GRKrVHYTLGT69PYlqqWQHO\r\na=fingerprint:sha-256 41:5C:01:6E:C0:1B:21:F1:0D:28:95:2E:4E:42:F6:64:F3:DB:DD:E3:18:54:32:28:3D:2F:9C:80:38:FA:E0:2Ca=candidate:candidate:1 1 UDP 2015363327 47.243.79.43 46008 typ host\r\na=candidate:candidate:1 1 UDP 2015363327 47.243.79.43 46008 typ host\r\na=candidate:candidate:2 1 TCP 1015021823 47.243.79.43 9 typ host tcptype active\r\na=candidate:candidate:3 1 TCP 1010827519 47.243.79.43 32450 typ host tcptype passive\r\na=candidate:candidate:3 1 TCP 1010827519 47.243.79.43 32450 typ host tcptype passive\r\na=candidate:candidate:2 1 TCP 1015021823 47.243.79.43 9 typ host tcptype active\r\na=candidate:candidate:4 1 UDP 2015363583 fe80::216:3eff:fe22:644f 12231 typ host\r\na=candidate:candidate:4 1 UDP 2015363583 fe80::216:3eff:fe22:644f 12231 typ host\r\na=candidate:candidate:5 1 TCP 1015022079 fe80::216:3eff:fe22:644f 9 typ host tcptype active\r\na=candidate:candidate:5 1 TCP 1015022079 fe80::216:3eff:fe22:644f 9 typ host tcptype active\r\na=candidate:candidate:6 1 TCP 1010827775 fe80::216:3eff:fe22:644f 6988 typ host tcptype passive\r\na=candidate:candidate:6 1 TCP 1010827775 fe80::216:3eff:fe22:644f 6988 typ host tcptype passive\r\na=candidate:candidate:1 2 UDP 2015363326 47.243.79.43 40782 typ host\r\na=candidate:candidate:1 2 UDP 2015363326 47.243.79.43 40782 typ host\r\na=candidate:candidate:2 2 TCP 1015021822 47.243.79.43 9 typ host tcptype active\r\na=candidate:candidate:2 2 TCP 1015021822 47.243.79.43 9 typ host tcptype active\r\na=candidate:candidate:3 2 TCP 1010827518 47.243.79.43 64559 typ host tcptype passive\r\na=candidate:candidate:3 2 TCP 1010827518 47.243.79.43 64559 typ host tcptype passive\r\na=candidate:candidate:4 2 UDP 2015363582 fe80::216:3eff:fe22:644f 39166 typ host\r\na=candidate:candidate:5 2 TCP 1015022078 fe80::216:3eff:fe22:644f 9 typ host tcptype active\r\na=candidate:candidate:4 2 UDP 2015363582 fe80::216:3eff:fe22:644f 39166 typ host\r\na=candidate:candidate:5 2 TCP 1015022078 fe80::216:3eff:fe22:644f 9 typ host tcptype active\r\na=candidate:candidate:6 2 TCP 1010827774 fe80::216:3eff:fe22:644f 16286 typ host tcptype passive\r\na=candidate:candidate:6 2 TCP 1010827774 fe80::216:3eff:fe22:644f 16286 typ host tcptype passive\r\na=candidate:candidate:7 1 UDP 1679819007 47.243.79.43 46008 typ srflx raddr 172.22.181.115 rport 46008\r\na=candidate:candidate:7 1 UDP 1679819007 47.243.79.43 46008 typ srflx raddr 172.22.181.115 rport 46008\r\na=candidate:candidate:8 1 TCP 847249663 47.243.79.43 9 typ srflx raddr 172.22.181.115 rport 9 tcptype active\r\na=candidate:candidate:8 1 TCP 847249663 47.243.79.43 9 typ srflx raddr 172.22.181.115 rport 9 tcptype active\r\na=candidate:candidate:9 1 TCP 843055359 47.243.79.43 32450 typ srflx raddr 172.22.181.115 rport 32450 tcptype passive\r\na=candidate:candidate:9 1 TCP 843055359 47.243.79.43 32450 typ srflx raddr 172.22.181.115 rport 32450 tcptype passive\r\na=candidate:candidate:10 1 UDP 505413887 47.243.79.43 61903 typ relay raddr 172.22.181.115 rport 46008\r\na=candidate:candidate:10 1 UDP 505413887 47.243.79.43 61903 typ relay raddr 172.22.181.115 rport 46008\r\na=candidate:candidate:7 2 UDP 1679819006 47.243.79.43 40782 typ srflx raddr 172.22.181.115 rport 40782\r\na=candidate:candidate:7 2 UDP 1679819006 47.243.79.43 40782 typ srflx raddr 172.22.181.115 rport 40782\r\na=candidate:candidate:8 2 TCP 847249662 47.243.79.43 9 typ srflx raddr 172.22.181.115 rport 9 tcptype active\r\na=candidate:candidate:8 2 TCP 847249662 47.243.79.43 9 typ srflx raddr 172.22.181.115 rport 9 tcptype active\r\na=candidate:candidate:9 2 TCP 843055358 47.243.79.43 64559 typ srflx raddr 172.22.181.115 rport 64559 tcptype passive\r\na=candidate:candidate:9 2 TCP 843055358 47.243.79.43 64559 typ srflx raddr 172.22.181.115 rport 64559 tcptype passive\r\na=candidate:candidate:10 2 UDP 505413886 47.243.79.43 63580 typ relay raddr 172.22.181.115 rport 40782\r\na=candidate:candidate:10 2 UDP 505413886 47.243.79.43 63580 typ relay raddr 172.22.181.115 rport 40782\r\n

Response elements

Element

Type

Description

Example

object

AccessDeniedDetail

string

Details about the access denial.

None

Message

string

The error description.

None

RequestId

string

The request ID.

xik-x**

Model

object

The returned result.

CallId

string

The unique identifier for each call.

wamid-xx**

Code

string

The request status code.

  • OK: The request was successful.

  • For other error codes, see Error codes.

OK

Success

boolean

Indicates whether the call was successful.

  • true: The call was successful.

  • false: The call failed.

false

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "xik-x**",
  "Model": {
    "CallId": "wamid-xx**"
  },
  "Code": "OK",
  "Success": false
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.