API docs by Redocly

Neuravoice API (1.0.0)

Download OpenAPI specification:

API documentation for publicly available endpoints.

Outbound Calling

Operations related to calling outbound.

Schedule outbound calls

This endpoint can be used to schedule one or many outbound calls to phone numbers. Each phone number must be unique and can only be scheduled once in this request. The request payload should include a list of calls to be scheduled, each with the necessary details. Optionally, a list of success metrics can be provided to track the outcome of each call.

Authorizations:
OAuth2
Request Body schema: application/json
required
Array of objects or null

(Optional) List of success metrics, where each item is a key-value pair representing a metric. The name of the key (e.g., "was_service_provided") within success_metrics is up to you, allowing for flexibility to define custom metrics tailored to your specific requirements. The type field within each metric must always be a string representing the expected type of the value, such as "boolean", "email", etc. This indicates what type of data is expected for that particular metric.

required
Array of objects non-empty

List of calls to be scheduled. Each phone number must start with "1" and have a minimum length of 10 digits.

Responses

Request samples

Content type
application/json
{
  • "successMetrics": [
    ],
  • "scheduleCalls": [
    ]
}

Response samples

Content type
application/json
{
  • "+15141234567": "8c1420cc-afa1-45f8-971e-14e0e5ba68a9",
  • "+15147891234": "8426874e-7bfe-481f-a1e7-d86f030b94d0"
}