---
title: "Control Call"
method: POST
path: "/calls/v1/conversations/{id}/control"
tags: ["Calls"]
---

# Control Call

`POST /calls/v1/conversations/{id}/control`

This API will allow you to control the call.

## Path parameters

- `id` string, required

## Request body

- union
  - ControlConversationSayDTO
    - `type` 'say' | 'end' | 'forward' | 'dtmf' | 'sms', required — This is the type of the control you would like to make to the call.
    - `message` string, required — Provide the message to the assistant to say.
  - ControlConversationEndDTO
    - `type` 'say' | 'end' | 'forward' | 'dtmf' | 'sms', required — This is the type of the control you would like to make to the call.
    - `message` string — Provide a message to the assistant to say before ending the call. Leave it blank if you don't want to say anything.
  - ControlConversationForwardDTO
    - `type` 'say' | 'end' | 'forward' | 'dtmf' | 'sms', required — This is the type of the control you would like to make to the call.
    - `message` string — Provide an message to the assistant to say before forwarding the call. Leave it blank if you don't want to say anything.
    - `number` string, required — This is the phone number to which the call will be forwarded. This field is required when `type=forward`.
    - `callerId` string — This is the phone number from which the call will be forwarded. By default, the callerId will be the phone number of the assistant if not provided. Use `callerId` to specify a different callerId for the forwarded call. This field is used when `type=forward`.
    - `extension` string — This is the extension number of the forward. Leave it blank if phone number is not having any extension. This field can be configured only when `type=forward`.
    - `sipUrl` string — This is the SIP URL to which the call will be forwarded. This field is used when `type=forward`. If sipUrl is provided, then number and extension fields will be ignored.
  - ControlConversationDTMFDTO
    - `type` 'say' | 'end' | 'forward' | 'dtmf' | 'sms', required — This is the type of the control you would like to make to the call.
    - `dtmf` string, required — This is the DTMF of the control. This field is required when `type=dtmf`.
  - ControlConversationSMSDTO
    - `type` 'say' | 'end' | 'forward' | 'dtmf' | 'sms', required — This is the type of the control you would like to make to the call.
    - `smsData` object, required — This is the data of the sms. This field is required when `type=sms`.
      - `to` string, required — This is the phone number of the receiver.
      - `message` string, required — This is the message that will be sent to the receiver.
      - `from` string, required — This is the phone number of the sender.

## Response `200`

Successful response

- object
  - `message` string
  - `data` object
    - `success` boolean — True if the call is controlled successfully.

---

[API](https://skmtc.net/interactly/apis/interactly-api.md) · [All operations](https://skmtc.net/interactly/apis/interactly-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/interactly/interactly-api/versions/f39cdcb1f4e4/schema)