Pre-announce a call
POST/partner/v1/businesses/{businessId}/call-authentication/pre-announce
Declare an outbound call to Hiya immediately before placing it,
identifying the business by its Hiya businessId. A matching call
placed within timeToLiveSeconds is authenticated and/or branded for
the recipient.
This is a real-time, per-call action, called by the originator's calling infrastructure (not the management console).
Path Parameters
The ID of the business, assigned by Hiya. A value that can't be parsed as a UUID is rejected with
400
INVALID_FIELD
404
9b8a1c4e-2c0f-4f3d-9a1e-7b3a2b4c6d8fBody
required
Responses
- 200
- 202
- 400
- 401
- 404
- 500
- 503
The pre-announce was stored in every region responsible for the call.
Response Body
The pre-announce was stored in at least one region responsible for the
call, but not in all of them. regionalResponses shows which.
Response Body
The request is invalid — for example a businessId that isn't a
UUID, a missing originatingPhone, terminatingPhone or
timeToLiveSeconds, a value that can't be parsed as a phone number,
a terminatingPhone with no country (a non-geographic number such
as +800, +881, +882 or +883), or a callTracingInfo that
isn't flat or is over its limits.
Response Body
The API key is missing or invalid, or you may not pre-announce for
this calling number: originatingPhone isn't registered with Hiya,
belongs to another business, or doesn't have Secure Branding active.
Secure Branding is active when it is enabled for both the number and
the business and the business is active. Returned as
UNAUTHORIZED; the message says which.
Response Body
The business doesn't exist or isn't yours, or call authentication
isn't enabled for your account. All of these return the same
NOT_FOUND error.
Response Body
Something went wrong on our side.
Response Body
The pre-announce couldn't be stored in any region responsible for the call. Retry the request.
Response Body