Delete a Phonebook

Delete a phonebook.

Request URL

GET {base_url}/{api_path}/phonebook/delete?id={id}&access_token={access_token}

Request parameters

Table 1.
Parameter Required Type Description
id Yes Integer The unique ID of the phonebook.
Note: You can query the phonebook's ID using Search Specific Phonebooks.

Response parameters

Table 2.
Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.

Examples

Request example

GET /openapi/v1.0/phonebook/delete?id=9&access_token=vtkE9as9ILt8D7zd20beBzd8dL2uTcOL HTTP/1.1  

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}