Créer un fournisseur de téléphone

Créer un fournisseur de téléphone. L’objet credentials nécessite différentes propriétés selon le fournisseur de téléphone (indiqué au moyen de la propriété name).

POST https://{tenantDomain}/api/v2/branding/phone/providers

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    phone "github.com/auth0/go-auth0/management/management/branding/phone"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &phone.CreateBrandingPhoneProviderRequestContent{
        Name: management.PhoneProviderNameEnumTwilio,
        Credentials: &management.PhoneProviderCredentials{
            TwilioProviderCredentials: &management.TwilioProviderCredentials{
                AuthToken: "auth_token",
            },
        },
    }
    client.Branding.Phone.Providers.Create(
        context.TODO(),
        request,
    )
}

201

{
  "configuration": {
    "delivery_methods": [],
    "sid": "<string>",
    "default_from": "<string>",
    "mssid": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "disabled": true,
  "id": "<string>",
  "tenant": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Corps

application/jsonapplication/x-www-form-urlencoded

Schéma de configuration du fournisseur de téléphone

credentials · object · requis

Les identifiants du fournisseur requis pour s’authentifier auprès de celui-ci.

Option 1

Option 2

Show child attributes

name · enum<string> · requis

Nom du fournisseur de notifications téléphoniques

Options disponibles: twilio, custom

Required string length: 1 - 100

configuration · object

Option 1

Option 2

Show child attributes

disabled · boolean

Indique si le fournisseur est activé (false) ou désactivé (true).

Réponse

201

application/json

Le fournisseur de notifications téléphoniques a été créé avec succès.

Schéma de configuration du fournisseur de téléphone

name · enum<string> · requis

Nom du fournisseur de notifications téléphoniques

Options disponibles: twilio, custom

Required string length: 1 - 100

channel · enum<string>

Indique le type de notifications que ce fournisseur peut recevoir.

Options disponibles: phone

Maximum string length: 100

configuration · object

Option 1

Option 2

Show child attributes

created_at · string<date-time>

La date et l’heure de création du fournisseur au format ISO 8601

Maximum string length: 27

disabled · boolean

Indique si le fournisseur est activé (false) ou désactivé (true).

id · string

Required string length: 1 - 255

tenant · string

Le nom du locataire

Required string length: 1 - 255

updated_at · string<date-time>

La date et l’heure de la dernière mise à jour du fournisseur au format ISO 8601

Maximum string length: 27