Get phone metadata status

get

https://sandbox-api.coris.ai/api/v0_2/establishment/{establishment_id}/phones/metadata/

Returns the state of a refresh started with Refresh phone metadata. To read the refreshed numbers, use Get establishment phones.

Lifecycle: 425 means not ready, and 500 means the refresh finished or failed. See Handle async requests.

sequenceDiagram
  accTitle: Get phone metadata status sequence diagram
  accDescr: Get phone metadata status. You send POST .../phones/metadata/. Coris replies 201 request_id. You send GET ?request_id=... Coris replies 425 not ready. You send GET ?request_id=... Coris replies 500 refresh finished. Coris sends POST callback_url, if sent.
  participant You
  participant Coris
  You->>Coris: POST .../phones/metadata/
  Coris-->>You: 201 request_id
  You->>Coris: GET ?request_id=...
  Coris-->>You: 425 not ready
  You->>Coris: GET ?request_id=...
  Coris-->>You: 500 refresh finished
  Coris->>You: POST callback_url, if sent

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

425

Not ready. Wait, then poll again.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/html

application/json

400request_id is missing or belongs to a different establishment. The body is a plain-text message. Send the request_id from the POST to this establishment.

401The key is missing, or it is wrong for this host. Send Authorization: Token YOUR_API_KEY with a key issued for this environment.

403This feature is not enabled for your workspace, or your plan does not include it. Ask Coris support. A scoped key cannot use this route, and gets JSON with detail. Use a key without account limits.

404No item has this ID in your workspace. Check the ID and the environment.

429You passed a rate limit. If Retry-After is present, wait that many seconds, then retry. If it is absent, you hit the concurrency limit, so back off for a few seconds and reduce parallel calls.

500This route returns 500 when the refresh ends, whether it worked or not, and on a server error. Read the phones to see the result.