Phone Numbers - Get Search Result

Référence

Service:: Communication

Version d'API:: 2022-12-01

Obtient un résultat de recherche de numéro de téléphone par ID de recherche.

GET {endpoint}/availablePhoneNumbers/searchResults/{searchId}?api-version=2022-12-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string url	Ressource de communication, par exemple https://resourcename.communication.azure.com
searchId	path	True	string	ID de recherche.
api-version	query	True	string	Version de l’API à appeler

Réponses

Nom	Type	Description
200 OK	PhoneNumberSearchResult	Succès
Other Status Codes	CommunicationErrorResponse	Échec

Exemples

Get PhoneNumber Search Result

Exemple de requête

HTTP

GET https://resourcename.communication.azure.com//availablePhoneNumbers/searchResults/378ddf60-81be-452a-ba4f-613198ea6c28?api-version=2022-12-01

Exemple de réponse

Code d’état:: 200

{
  "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",
  "errorCode": 1000,
  "error": "OutOfStock"
}

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.
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.

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