End a registered call | Sample

1 parameter · 2 body fields

tokenstringrequired

Authentication token supplied in the request header; the required scope is `calls:write`.

Details for ending a registered call.

idstringrequired

`id` returned when registering the call using the [`calls.add`](/methods/calls.add) method.

durationintegeroptional

Call duration in seconds

2 status codes

200Returns an object with `ok` set to true confirming that the call was ended.

okbooleanrequired

Allowed:true

defaultReturned when the call identifier, authentication, or request data cannot be processed; the response contains `ok` set to false.

okbooleanrequired

Allowed:false

Error handling

id must be supplied and must identify a call registered through calls.add. When provided, duration must be an integer representing the call length in seconds.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.callsEnd.create({
  id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  duration: 20,
});

{
  "ok": true
}

Request

Response

Errors