Récupère une ressource SmsNumberRequest.
const url = 'https://api.facteur.local/inboxes/example/sms-number/request';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.facteur.local/inboxes/example/sms-number/request \ --header 'Authorization: Bearer <token>'Récupère une ressource SmsNumberRequest.
Authorizations
Section intitulée « Authorizations »- bearerAuthws:read
Parameters
Section intitulée « Parameters »Path Parameters
Section intitulée « Path Parameters »Identifiant SmsNumberRequest
Responses
Section intitulée « Responses »Ressource SmsNumberRequest
La demande d’un numéro SMS pour une inbox, et où elle en est.
object
Le pays demandé, un code de deux lettres majuscules.
L’identifiant de cette demande.
L’inbox du chemin : la clé de la demande, puisqu’une inbox en a une à la fois.
pending et accepted prennent une place du plan ; fulfilled veut dire que le numéro a été donné.
Example
{ "number": "+447700900123", "state": "pending"}Aucune clé, ou une clé refusée. WWW-Authenticate dit où lire comment en présenter une.
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}La clé n’a pas la permission de l’opération, ou l’opération refuse toutes les clés.
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}Il n’y a rien avec cet identifiant à la portée de la clé. La réponse est la même pour une autre organisation ou un espace de travail que la clé ne nomme pas.
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}Plus d’appels que la clé n’en peut faire en une minute. Retry-After dit quand réessayer.
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}Any refusal: an application/problem+json body whose code says which.
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}