Register outbound call
POST/v1/originators
This API is invoked to notify Hiya that the enterprise is about to make an outgoing phone call. It will pre-authenticate the phone call and optionally show additional real-time information to the end user, if provided.
Body
required
Responses
- 200
- 400
- 401
- 403
- 404
- 408
- 410
- 429
- 500
Call Registration has succeeded
Response Body
Bad Request - A required parameter is missing or has an invalid value.
Response Body
Unauthorized - The API Key is invalid or missing.
Response Body
Forbidden - The API Key doesn't have the necessary authorization to access this resource.
Response Body
Not Found - This API doesn't exist (or has been fully deprecated)
Response Body
Request Timeout - A complete request was not received by the server within its allotted timeout period. It's safe to retry.
Response Body
Gone - You must stop calling this API permanently once you receive this status code
Response Body
Too Many Requests - The number of requests within a given time period was exceeded.
Response Body
Internal Server Error - The server has experienced an unexpected condition and is unable to process the request
Response Body