pub struct Tsp {
pub client: Client,
}Fields§
§client: ClientImplementations§
source§impl Tsp
impl Tsp
sourcepub async fn get(&self) -> Result<TspResponse>
pub async fn get(&self) -> Result<TspResponse>
Get account’s TSP information.
This function performs a GET to the /tsp endpoint.
Get information on Telephony Service Provider on an account level.
Scopes: tsp:read:admin
Rate Limit Label: Light
Prerequisites:
- A Pro or a higher plan.
sourcepub async fn update(&self, body: &TspUpdateRequest) -> Result<()>
pub async fn update(&self, body: &TspUpdateRequest) -> Result<()>
Update account’s TSP information.
This function performs a PATCH to the /tsp endpoint.
Update information of the Telephony Service Provider set up on an account.
Prerequisites:
TSP account option should be enabled.
Scopes: tsp:write:admin
Rate Limit Label: Light
sourcepub async fn user_ts_ps(&self, user_id: &str) -> Result<UserTsPsResponse>
pub async fn user_ts_ps(&self, user_id: &str) -> Result<UserTsPsResponse>
List user’s TSP accounts.
This function performs a GET to the /users/{userId}/tsp endpoint.
A user can have a maximum of two TSP accounts. Use this API to list all TSP accounts of a user.
Scopes: tsp:read:admin tsp:read
Rate Limit Label: Medium
Parameters:
user_id: &str– The user ID or email address of the user. For user-level apps, passmeas the value for userId.
sourcepub async fn user_create(
&self,
user_id: &str,
body: &TspAccountsList
) -> Result<TspAccountsList>
pub async fn user_create( &self, user_id: &str, body: &TspAccountsList ) -> Result<TspAccountsList>
Add a user’s TSP account.
This function performs a POST to the /users/{userId}/tsp endpoint.
Add a user’s TSP account.
Scopes: tsp:write:admin tsp:write
Rate Limit Label: Light
Parameters:
user_id: &str– The user ID or email address of the user. For user-level apps, passmeas the value for userId.
sourcepub async fn user(&self, user_id: &str, tsp_id: &str) -> Result<TspAccount>
pub async fn user(&self, user_id: &str, tsp_id: &str) -> Result<TspAccount>
Get a user’s TSP account.
This function performs a GET to the /users/{userId}/tsp/{tspId} endpoint.
Each user can have a maximum of two TSP accounts. Use this API to retrieve details of a specific TSP account enabled for a specific user.
Scopes: tsp:read:admin tsp:read
Rate Limit Label: Light
Parameters:
user_id: &str– The user ID or email address of the user. For user-level apps, passmeas the value for userId.tsp_id: &str– Audio types:1- Toll-free Call-in & Call-out.2- Toll
3- SIP Connected Audio.
sourcepub async fn user_delete(&self, user_id: &str, tsp_id: &str) -> Result<()>
pub async fn user_delete(&self, user_id: &str, tsp_id: &str) -> Result<()>
Delete a user’s TSP account.
This function performs a DELETE to the /users/{userId}/tsp/{tspId} endpoint.
Delete a user’s TSP account.
Scopes: tsp:write:admin tsp:write
Rate Limit Label: Light
Parameters:
user_id: &str– The user ID or email address of the user. For user-level apps, passmeas the value for userId.tsp_id: &str– Audio types:1- Toll-free Call-in & Call-out.2- Toll
3- SIP Connected Audio.
sourcepub async fn user_update(
&self,
user_id: &str,
tsp_id: &str,
body: &TspAccountData
) -> Result<()>
pub async fn user_update( &self, user_id: &str, tsp_id: &str, body: &TspAccountData ) -> Result<()>
Update a TSP account.
This function performs a PATCH to the /users/{userId}/tsp/{tspId} endpoint.
Update a user’s TSP account.
Scopes: tsp:write:admin tsp:write
Rate Limit Label: Light
Parameters:
user_id: &str– The user ID or email address of the user. For user-level apps, passmeas the value for userId.tsp_id: &str– Audio types:1- Toll-free Call-in & Call-out.2- Toll
3- SIP Connected Audio.
sourcepub async fn url_update(
&self,
user_id: &str,
body: &TspGlobalDialIn
) -> Result<()>
pub async fn url_update( &self, user_id: &str, body: &TspGlobalDialIn ) -> Result<()>
Set global dial-in URL for a TSP user.
This function performs a PATCH to the /users/{userId}/tsp/settings endpoint.
A global dial-in page can provide a list of global access numbers using which audio conferencing can be conducted. By calling this API, you can set the url for the global dial-in page of a user whose Zoom account has TSP and special TSP with third-party audio conferencing options enabled.
Scopes:tsp:write:admin tsp:writeRate Limit Label: Light
Parameters:
user_id: &str– The userId or email address of the user.