Create MS Teams

post

{protocol}://{server}/api/admin/voice/v1beta/accounts/{accountId}/msteams-elements

This API requires the Account Administrator role.

Add a new MS Teams element for an Account with required data.

Only one instance of Microsoft Teams element can be created for an account.

The following field must be unique otherwise a HTTP 409 Conflict will be returned:

name

Will trigger asynchronous updates, the status of which should be monitored via /msteams-elements/{elementId}.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

Body Params

Microsoft Teams

MS Teams Element Model

name

string

required

length between 1 and 255

^[a-zA-Z0-9\p{L}\-\_\.\ ]+$

Name of the MS Teams Element

description

string

length ≤ 1024

(^$|^[a-zA-Z0-9\p{L}\-\_\.\ ]+$)

didNumbers

array of strings

length ≤ 2000

The did numbers in the E.164 format

didNumbers

domain

string

length between 3 and 255

^((?!-)[A-Za-z0-9\p{L}-]{1,63}(?<!-)\.)+[A-Za-z\p{L}]{2,63}$

Domain name configured for the MS Teams Element

status

string

enum

This field indicates the current status of an Element.

An explanation of the values is listed below:

SUCCESS - An Element was created/updated successfully.
FAILED - operation on Element was failed.
IN_PROGRESS - operation performed on an Element is in progress.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

202Accepted

400Constraint Violation

401Unauthorized

403Forbidden

404Not Found

409Conflict

500All other application errors