Voice SDKs
Client webSDK
Subscriber Management API
6 min
this guide explains how to manage subscribers (end users or agents) in your application using exotel’s client sdk these apis let you create, update, fetch, and delete subscriber accounts that are used for webrtc/voip calling base url https //api exotel com/v2/accounts/{accountsid} auth basic auth with accountsid\ token 1\ create subscribers create one or more subscribers in a single request (up to 25 subscribers at a time) endpoint post /subscribers request body example { "subscribers" \[ { "user name" "alice", "password" " ", "email" "alice\@example com" }, { "user name" "bob", "password" " ", "email" "bob\@example com" } ] } response example { "request id" "22c70a0c46414af9b7136491c31f95a6", "method" "post", "http code" 200, "metadata" { "total" 2, "success" 2 }, "response" \[ { "code" 200, "status" "success", "data" { "user name" "alice", "date created" "2023 06 05t09 32 49z", "date updated" "2023 06 05t09 32 49z", "email" "alice\@example com", "domain" "\<accountsid> voip exotel com", "status" "inactive", "display name" null, "dc id" null } }, { "code" 200, "status" "success", "data" { "user name" "bob", "date created" "2023 06 05t09 32 49z", "date updated" "2023 06 05t09 32 49z", "email" "bob\@example com", "domain" "\<accountsid> voip exotel com", "status" "inactive", "display name" null, "dc id" null } } ] } 2\ get subscriber details fetch details of subscribers by username or list with pagination endpoint get /subscribers query parameters user name (optional, comma separated) offset (default 0) page size (default 250, max 250) sample request get /subscribers?user name=alice,bob\&offset=0\&page size=250 response example { "request id" "f293bfb68b6e4a74a0f3bab31946c59b", "method" "get", "http code" 200, "metadata" { "page size" 250, "first page uri" "/v2/accounts/\<accountsid>/subscribers?offset=0\&page size=250\&user name=alice,bob", "prev page uri" null, "next page uri" null }, "response" \[ { "code" 200, "status" "success", "data" { "user name" "alice", "date created" "2023 06 05t09 32 49z", "date updated" "2023 06 05t09 32 49z", "email" "alice\@example com", "domain" "\<accountsid> voip exotel com", "status" "inactive", "display name" null, "dc id" null } }, { "code" 200, "status" "success", "data" { "user name" "bob", "date created" "2023 06 05t09 32 49z", "date updated" "2023 06 05t09 32 49z", "email" "bob\@example com", "domain" "\<accountsid> voip exotel com", "status" "inactive", "display name" null, "dc id" null } } ] } 3\ update subscriber update details for a single subscriber endpoint put /subscribers/{user name} request body example { "password" "newstrongpass\@123", "email" "alice updated\@example com" } response example { "request id" "e6b64e1460ac467a9680a8967ba4b4eb", "method" "put", "http code" 200, "response" { "code" 200, "status" "success", "data" { "user name" "alice", "date created" "2023 06 05t09 32 49z", "date updated" "2023 06 05t09 55 10z", "email" "alice updated\@example com", "domain" "\<accountsid> voip exotel com", "status" "inactive", "display name" null, "dc id" null } } } 4\ delete subscribers delete up to 50 subscribers in a single request endpoint delete /subscribers?user name=alice,bob response example { "request id" "7c004e095c8e4ae5b32e2244a7a1fef8", "method" "delete", "http code" 200, "metadata" { "total" 2, "success" 2 }, "response" \[ { "code" 200, "status" "success", "data" { "user name" "alice", "date created" "2023 06 05t09 32 49z", "date updated" "2023 06 05t09 32 49z", "email" "alice\@example com", "domain" "\<accountsid> voip exotel com", "status" "inactive", "display name" null, "dc id" null } }, { "code" 200, "status" "success", "data" { "user name" "bob", "date created" "2023 06 05t09 32 49z", "date updated" "2023 06 05t09 55 10z", "email" "bob\@example com", "domain" "\<accountsid> voip exotel com", "status" "inactive", "display name" null, "dc id" null } } ] } additional notes subscribers are required for webrtc sdk login & registration default subscriber status is inactive until first sdk registration bulk limits 25 on create , 50 on delete use strong passwords and rotate them periodically subscriber domain always follows \<accountsid> voip exotel com
🤔
Have a question?
Our knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.