curl --request GET \
--url https://api.telleo.ai/v1/counsellors/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.telleo.ai/v1/counsellors/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.telleo.ai/v1/counsellors/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Get a counsellor
One counsellor or admin of your account, active or deactivated.
Scope: human_calls:read or counsellors:manage.
curl --request GET \
--url https://api.telleo.ai/v1/counsellors/{id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.telleo.ai/v1/counsellors/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.telleo.ai/v1/counsellors/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Authorizations
Your AI calling API key (vak_call_ā¦). Authorization: Bearer <key> also works.
Path Parameters
Response
The counsellor.
Use as counsellor_id on POST /human-calls.
"counsellor"["COUNSELLOR"]
Whether this person can take a human call right now on your calling provider.
Why can_call is false, e.g. no mobile number on their profile (Vacademy Voice, Exotel) or no Airtel extension mapped.
inactive after DELETE /counsellors/{id} (deactivated); GET /counsellors lists active ones only.
active, invited, inactive Only on GET /counsellors/{id} (and write responses) for keys with counsellors:manage, and null when the login also belongs to another account (shared_account). Digits with the country code, as stored on the profile.
"919876543210"
Only on single-counsellor responses, for keys with counsellors:manage.
Only for counsellors:manage keys: whether the API may change this person (their roles here are counsellor roles only). Admins and other staff are false.
Only for counsellors:manage keys: the login also belongs to another account on the platform, so its name and mobile number cannot be changed through the API.
true when this request made the person a counsellor here; false when they already were (nothing changed).
The email already had a login on the platform: it was reused, its name, mobile and password were not changed, and no email was sent.
On deactivation / reactivation: what else changed (see the counsellors guide).
Non-fatal notes about what was (not) done, e.g. mobile_number_missing.
Show child attributes
Show child attributes