Phone Numbers - Search Available Phone Numbers

Référence

Service:: Communication

Version d'API:: 2022-12-01

Recherchez les numéros de téléphone disponibles à acheter.

POST {endpoint}/availablePhoneNumbers/countries/{countryCode}/:search?api-version=2022-12-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
countryCode	path	True	string	Code de pays ISO 3166-2, par exemple états-Unis.
endpoint	path	True	string url	Ressource de communication, par exemple https://resourcename.communication.azure.com
api-version	query	True	string	Version de l’API à appeler

Corps de la demande

Nom	Obligatoire	Type	Description
assignmentType	True	PhoneNumberAssignmentType	Type d’affectation des numéros de téléphone à rechercher. Un numéro de téléphone peut être attribué à une personne ou à une application.
capabilities	True	PhoneNumberCapabilities	Fonctionnalités d’un numéro de téléphone.
phoneNumberType	True	PhoneNumberType	Type de numéros de téléphone à rechercher, par exemple géographique ou tollFree.
areaCode		string	Code de zone du numéro de téléphone souhaité, par exemple 425.
quantity		integer	Quantité de numéros de téléphone souhaités. La valeur par défaut est 1.

Réponses

Nom	Type	Description
202 Accepted	PhoneNumberSearchResult	Le service a accepté la demande et commencera à traiter ultérieurement. Il retourne immédiatement « Accepté » et inclut des en-têtes « Operation-Location » et « Location ». Le côté client doit interroger davantage l’état de l’opération à l’aide de l’URL spécifiée dans l’en-tête « Operation-Location ». Lorsque l’opération se termine avec succès, interrogez le résultat final à l’aide de l’URL spécifiée dans l’en-tête « Location ». En-têtes Location: string Operation-Location: string operation-id: string search-id: string
Other Status Codes	CommunicationErrorResponse	Échec

Nom

Type

Description

202 Accepted

PhoneNumberSearchResult

Le service a accepté la demande et commencera à traiter ultérieurement. Il retourne immédiatement « Accepté » et inclut des en-têtes « Operation-Location » et « Location ». Le côté client doit interroger davantage l’état de l’opération à l’aide de l’URL spécifiée dans l’en-tête « Operation-Location ». Lorsque l’opération se termine avec succès, interrogez le résultat final à l’aide de l’URL spécifiée dans l’en-tête « Location ».

En-têtes

Location: string
Operation-Location: string
operation-id: string
search-id: string

Other Status Codes

CommunicationErrorResponse

Échec

Exemples

Search for phone numbers

Exemple de requête

HTTP

POST https://resourcename.communication.azure.com//availablePhoneNumbers/countries/US/:search?api-version=2022-12-01

{
  "phoneNumberType": "tollFree",
  "assignmentType": "application",
  "capabilities": {
    "sms": "inbound+outbound",
    "calling": "none"
  },
  "areaCode": "425",
  "quantity": 1
}

Exemple de réponse

Code d’état:: 202

Operation-Location: /phoneNumbers/operations/search_378ddf60-81be-452a-ba4f-613198ea6c28
Location: /availablePhoneNumbers/searchResults/378ddf60-81be-452a-ba4f-613198ea6c28
operation-id: search_378ddf60-81be-452a-ba4f-613198ea6c28
search-id: 378ddf60-81be-452a-ba4f-613198ea6c28

{
  "searchId": "378ddf60-81be-452a-ba4f-613198ea6c28",
  "phoneNumbers": [
    "+18001212121"
  ],
  "phoneNumberType": "tollFree",
  "assignmentType": "application",
  "capabilities": {
    "sms": "inbound+outbound",
    "calling": "none"
  },
  "cost": {
    "amount": 1.2,
    "currencyCode": "USD",
    "billingFrequency": "monthly"
  },
  "searchExpiresBy": "2020-11-19T16:31:49.048Z"
}

Définitions

Nom	Description
BillingFrequency	Fréquence à laquelle le coût est facturé.
CommunicationError	Erreur Communication Services.
CommunicationErrorResponse	Erreur Communication Services.
Error	Mappage des messages d’erreur aux codes
PhoneNumberAssignmentType	Représente le type d’affectation de l’offre.
PhoneNumberCapabilities	Fonctionnalités d’un numéro de téléphone.
PhoneNumberCapabilityType	Valeur de capacité pour l’appel.
PhoneNumberCost	Coût encouru pour un numéro de téléphone unique.
PhoneNumberSearchRequest	Représente une demande de recherche de numéro de téléphone pour rechercher des numéros de téléphone. Les numéros de téléphone trouvés sont temporairement conservés pour un achat suivant.
PhoneNumberSearchResult	Résultat d’une opération de recherche de numéro de téléphone.
PhoneNumberType	Représente le type de nombre de l’offre.

BillingFrequency

Fréquence à laquelle le coût est facturé.

Nom	Type	Description
monthly	string

CommunicationError

Erreur Communication Services.

Nom	Type	Description
code	string	Code d’erreur.
details	CommunicationError[]	Plus d’informations sur les erreurs spécifiques qui ont conduit à cette erreur.
innererror	CommunicationError	Erreur interne le cas échéant.
message	string	Message d’erreur.
target	string	Cible d’erreur.

CommunicationErrorResponse

Erreur Communication Services.

Nom	Type	Description
error	CommunicationError	Erreur Communication Services.

Error

Mappage des messages d’erreur aux codes

Nom	Type	Description
AllNumbersNotAcquired	string
AuthorizationDenied	string
BillingUnavailable	string
InvalidAddress	string
InvalidOfferModel	string
MissingAddress	string
NoError	string
NoWallet	string
NotEnoughCredit	string
NotEnoughLicenses	string
NumbersPartiallyAcquired	string
OutOfStock	string
ProvisioningFailed	string
PurchaseFailed	string
ReservationExpired	string
UnknownErrorCode	string
UnknownSearchError	string

PhoneNumberAssignmentType

Représente le type d’affectation de l’offre.

Nom	Type	Description
application	string
person	string

PhoneNumberCapabilities

Fonctionnalités d’un numéro de téléphone.

Nom	Type	Description
calling	PhoneNumberCapabilityType	Valeur de capacité pour l’appel.
sms	PhoneNumberCapabilityType	Valeur de capacité pour SMS.

PhoneNumberCapabilityType

Valeur de capacité pour l’appel.

Nom	Type	Description
inbound	string
inbound+outbound	string
none	string
outbound	string

PhoneNumberCost

Coût encouru pour un numéro de téléphone unique.

Nom	Type	Description
amount	number	Montant du coût.
billingFrequency	BillingFrequency	Fréquence à laquelle le coût est facturé.
currencyCode	string	Code monétaire ISO 4217 pour le montant du coût, par exemple USD.

PhoneNumberSearchRequest

Représente une demande de recherche de numéro de téléphone pour rechercher des numéros de téléphone. Les numéros de téléphone trouvés sont temporairement conservés pour un achat suivant.

Nom	Type	Valeur par défaut	Description
areaCode	string		Code de zone du numéro de téléphone souhaité, par exemple 425.
assignmentType	PhoneNumberAssignmentType		Type d’affectation des numéros de téléphone à rechercher. Un numéro de téléphone peut être attribué à une personne ou à une application.
capabilities	PhoneNumberCapabilities		Fonctionnalités d’un numéro de téléphone.
phoneNumberType	PhoneNumberType		Type de numéros de téléphone à rechercher, par exemple géographique ou tollFree.
quantity	integer	1	Quantité de numéros de téléphone souhaités. La valeur par défaut est 1.

PhoneNumberSearchResult

Résultat d’une opération de recherche de numéro de téléphone.

Nom	Type	Description
assignmentType	PhoneNumberAssignmentType	Type d’affectation du numéro de téléphone.
capabilities	PhoneNumberCapabilities	Fonctionnalités d’un numéro de téléphone.
cost	PhoneNumberCost	Coût encouru pour un numéro de téléphone unique.
error	Error	Mappage des messages d’erreur aux codes
errorCode	integer	Code d’erreur de la recherche.
phoneNumberType	PhoneNumberType	Type du numéro de téléphone, par exemple géographique ou tollFree.
phoneNumbers	string[]	Numéros de téléphone disponibles. Peut être inférieur à la quantité de recherche souhaitée.
searchExpiresBy	string	La date à laquelle ce résultat de recherche expire et les numéros de téléphone ne sont plus en attente. Un résultat de recherche expire en moins de 15 minutes, par exemple 2020-11-19T16:31:49.048Z.
searchId	string	ID de recherche.

PhoneNumberType

Représente le type de nombre de l’offre.

Nom	Type	Description
geographic	string
tollFree	string

Partager via

Phone Numbers - Search Available Phone Numbers

Paramètres URI

Corps de la demande

Réponses

Exemples

Search for phone numbers

Exemple de requête

Exemple de réponse

Définitions

BillingFrequency

CommunicationError

CommunicationErrorResponse

Error

PhoneNumberAssignmentType

PhoneNumberCapabilities

PhoneNumberCapabilityType

PhoneNumberCost

PhoneNumberSearchRequest

PhoneNumberSearchResult

PhoneNumberType

Ressources supplémentaires