Skip to content

List a contact's dial attempts

GET
/campaigns/{id}/contacts/{contact_id}/attempts
import { createClient, createResources } from "@morevoice/sdk";
const mv = createResources({
client: createClient({ baseUrl: "https://api.morevoice.ai/v1", auth: process.env.MOREVOICE_API_KEY }),
});
for await (const contact of mv.campaigns.contacts.listAttempts("cmp_ojFwMD7YNTROjaTP0i3ZFb", "ctc_NKhjnYPvBUr2gmEgqwqw5N")) {
console.log(contact);
}

Try it in the API playground with a test-mode key.

id
required
string
<= 200 characters /^cmp_[0-9A-Za-z]+$/

A campaign ID (cmp_…).

contact_id
required
string
<= 200 characters /^ctc_[0-9A-Za-z]+$/

A contact ID (ctc_…).

limit
integer
default: 20 >= 1 <= 100

How many objects to return, 1–100 (default 20).

starting_after
string
>= 1 characters <= 512 characters

A cursor (next_cursor) or object ID: return the objects after it (older).

ending_before
string
>= 1 characters <= 512 characters

A cursor or object ID: return the objects before it (newer).

MoreVoice-Version
string
/^\d{4}-\d{2}-\d{2}$/

The API version to use for this request. Defaults to the version the API key is pinned to.

Example
2026-11-01

OK

Media typeapplication/json

A contact’s dial attempts, newest first.

object
data
required
Array<object>

One dial attempt of a campaign contact.

object
answered_at
required
Any of:

An ISO-8601 timestamp in UTC.

string format: date-time
attempt_number
required
integer
>= -9007199254740991 <= 9007199254740991
call_id
required
Any of:

A call ID (prefix call_).

string
/^call_[0-9A-Za-z]+$/
campaign_id
required

A campaign ID (prefix cmp_).

string
/^cmp_[0-9A-Za-z]+$/
contact_id
required

A contact ID (prefix ctc_).

string
/^ctc_[0-9A-Za-z]+$/
disposition
required
string | null
duration_ms
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
end_reason
required
string | null
ended_at
required
Any of:

An ISO-8601 timestamp in UTC.

string format: date-time
id
required

A attempt ID (prefix att_).

string
/^att_[0-9A-Za-z]+$/
livemode
required

true in live mode, false in test mode.

boolean
object
required
string
Allowed value: campaign_attempt
phone
required
string
result
required

The result: answered, voicemail, voicemail_left, busy, no_answer, declined, invalid, failed, opted_out, interrupted, not_dialled.

string | null
ring_ms
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
ringing_at
required
Any of:

An ISO-8601 timestamp in UTC.

string format: date-time
sip_status
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
started_at
required

An ISO-8601 timestamp in UTC.

string format: date-time
status
required

Dialing, ringing, connected or done.

string
talk_ms
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
has_more
required

Whether more objects follow in the requested direction.

boolean
next_cursor
required

Pass as starting_after (or ending_before, when paging backwards) to continue; null on the last page.

string | null
object
required
string
Allowed value: list
url
required

The list’s path.

string
Example
{
"data": [
{
"answered_at": "2026-11-02T09:14:09.900Z",
"attempt_number": 1,
"call_id": "call_3Hk9PqR2sT",
"campaign_id": "cmp_2Yb7mCq9aPLk",
"contact_id": "ctc_1aB2cD3eF4g",
"disposition": "interested",
"duration_ms": 210000,
"end_reason": "assistant-ended",
"ended_at": "2026-11-02T09:17:30.000Z",
"id": "att_4dE5fG6hJ7",
"livemode": true,
"object": "campaign_attempt",
"phone": "+972501234567",
"result": "answered",
"ring_ms": 8700,
"ringing_at": "2026-11-02T09:14:01.200Z",
"sip_status": 200,
"started_at": "2026-11-02T09:14:00.000Z",
"status": "done",
"talk_ms": 200100
}
],
"has_more": false,
"next_cursor": null,
"object": "list",
"url": "/v1/campaigns/cmp_2Yb7mCq9aPLk/contacts/ctc_1aB2cD3eF4g/attempts"
}

The request is invalid: a parameter is missing, malformed or unknown, or the version header is unknown.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
"error": {
"code": "parameter_missing",
"doc_url": "https://docs.morevoice.ai/api/errors#parameter-missing",
"message": "Missing required parameter: to.",
"param": "to",
"request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
"type": "invalid_request_error"
}
}
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

No valid API key was sent.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
"error": {
"code": "invalid_api_key",
"doc_url": "https://docs.morevoice.ai/api/errors#invalid-api-key",
"message": "Invalid API key.",
"request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
"type": "authentication_error"
}
}
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

The key may not do this (a missing scope, a plan limit, or a compliance block).

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
"error": {
"code": "missing_scope",
"doc_url": "https://docs.morevoice.ai/api/errors#missing-scope",
"message": "This API key lacks the calls:write scope.",
"request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
"type": "permission_error"
}
}
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

No object with this ID exists in this organisation and mode.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
"error": {
"code": "resource_missing",
"doc_url": "https://docs.morevoice.ai/api/errors#resource-missing",
"message": "No such object: 'call_4Gk2'.",
"param": "id",
"request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
"type": "not_found"
}
}
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

Too many requests, or no call capacity right now. Retry after the Retry-After delay.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
"error": {
"code": "rate_limited",
"doc_url": "https://docs.morevoice.ai/api/errors#rate-limited",
"message": "Too many requests. Retry after 1 second.",
"request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
"type": "rate_limit_error"
}
}
Retry-After
integer

Seconds to wait before retrying.

X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

Something went wrong on MoreVoice’s side. Retry with the same Idempotency-Key.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
"error": {
"code": "internal_error",
"doc_url": "https://docs.morevoice.ai/api/errors#internal-error",
"message": "Something went wrong on MoreVoice's side.",
"request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
"type": "api_error"
}
}
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.