1. Teleboard | Support Center
  2. Solution home
  3. API Documentation
  4. REST API - POST Requests
Open navigation

POST/call/pickup

Function


The POST/call/pickup method allows a user to pick up a call on a selected phone number. For this method to work, the call to be picked up must be placed using the POST/send/call method to identify the call with a unique ID.


Parameters


There are no parameters in the header. All parameters go in the body in JSON Raw format.


ParameterTypeOperation
dnumberstringThe phone number where the call is to be picked up at.
callidstringA unique ID number for the call. This need to be obtained from the uniqueid field in the response received from the post/send/call method, once the call is placed from that method. 

Example


To pickup a call at on internal phone number 1214840  use this syntax:


HTTPS method: POST


Header


webserv.telebroad.com/api/teleconsole/rest/call/pickup


Body


{"dnumber":"1214840", "callid":"1519784628.70134037"}


Response:


If the call was redirected successfully:


{

    "error": null,

    "result": "1"

}


If there was a problem redirecting the call (usually due to wrong uniqueid or if the call has already ended):


{

    "error":{

        "code": 444,

        "message": "The call does not exist."

    }

}

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article