List phone book entries

GET

/phonebooks/:phone_book_id/entries

GET

/v2/phonebooks/:phone_book_id/entries

curl https://api.synthflow.ai/v2/phonebooks/a19da8ff-c89e-4628-94b6-d81193f883c6/entries \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "status": "ok",
  "response": {
    "total": 2,
    "page_size": 10,
    "page_number": 1,
    "items": [
      {
        "phone_book_entry_id": "b29da8ff-c89e-4628-94b6-d81193f883c7",
        "phone_book_id": "a19da8ff-c89e-4628-94b6-d81193f883c6",
        "phone_number": "+12025551234",
        "transfer_condition": "When the caller asks for a sales representative"
      },
      {
        "phone_book_entry_id": "c39da8ff-c89e-4628-94b6-d81193f883c8",
        "phone_book_id": "a19da8ff-c89e-4628-94b6-d81193f883c6",
        "phone_number": "+12025555678",
        "transfer_condition": "When the caller asks for technical support"
      }
    ]
  }
}

List the entries of a phone book.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

phone_book_idstringRequired

Phone book ID.

Query parameters

page_numberintegerOptional>=1Defaults to 1

Page number.

page_sizeintegerOptional1-100Defaults to 10

Number of entries per page.

Response

200

statusstringOptional

Whether the request was successful.

responseobjectOptional