--- title: "Add new call" method: POST path: "/calls/1/conferences/{conferenceId}/call" tags: ["channels", "voice", "calls", "conference-calls", "conference-management"] --- # Add new call `POST /calls/1/conferences/{conferenceId}/call` ## Request - Base URL: `https://api.infobip.com` (the document declares no server; this is the origin it was published from) - URL: `https://api.infobip.com/calls/1/conferences/{conferenceId}/call` - Auth: one of: - API key in header `Authorization` - API key in header `Authorization` - HTTP basic - OAuth 2 - Client credentials - Token URL: `https://api.infobip.com/auth/1/oauth2/token` Create a new outbound call and add it to a conference. ## Path parameters - `conferenceId` string, required ## Request body - 707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40AddNewCallRequest - `callRequest` 08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779eActionCallRequest, required - `endpoint` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611CallEndpoint, required: Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls. - `type` 'PHONE' | 'SIP' | 'WEBRTC' | 'VIBER' | 'WHATSAPP' | 'WEBSOCKET' - `from` string: Caller identifier. Must be a number in the [E.164](https://en.wikipedia.org/wiki/E.164) format for calls to `PHONE`, a string for calls to `WEBRTC` or `SIP`, and a Viber Voice number for calls to `VIBER`. Field is mandatory for `VIBER` endpoint and calls to emergency numbers. - `fromDisplayName` string: Display name to show when placing calls towards WEBRTC endpoints. Can be any alphanumeric string. - `connectTimeout` integer: Time to wait, in seconds, before the called party answers the call. - `recording` 6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cbCallRecordingRequest - `recordingType` 'AUDIO' | 'AUDIO_AND_VIDEO', required: Recording type. - `customData` object: Custom data. - `filePrefix` string: Custom name for the recording's zip file. Applicable only when SFTP server is enabled on [Voice settings page](https://portal.infobip.com/apps/voice/recording/settings). Using the same `filePrefix` will override the files on the SFTP server. - `channels` 'MONO' | 'STEREO': Audio channel mode. If set to `STEREO`, incoming audio from the endpoint is recorded on the left channel and outgoing audio on the right channel. - `machineDetection` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611MachineDetectionRequest - `enabled` boolean, required: Indicates whether to enable answering machine detection. If set to true, answering machine detection will generate an event indicating if the call was answered by a human or a machine. - `messageDetectionTimeout` integer: Indicates maximum duration for detecting the end of the message when a answering machine is detected. If set to 0, no end of message detection will be done. Expressed in seconds. - `detectionTime` number, double: Indicates time in seconds during which answering machine detection will analyse the call before making a decision. Shorter detection time may come at the expense of accuracy. Must be lower than `messageDetectionTimeout` if `messageDetectionTimeout` is specified. - `maxDuration` integer: Max duration in seconds. - `customData` object: Custom data. - `connectOnEarlyMedia` boolean: Indicates whether to connect a new call on early media. Otherwise, the call will be connected after being established. Cannot be `true` when `ringbackGeneration` is enabled. - `ringbackGeneration` 27eaa09c2aeef6932f3271ca5bde4158d33d6ab404b64c38db12c844a2084089RingbackGeneration: Option to generate a consistent local ringback tone, overriding remote ringing tones. If enabled, the ringback will be generated for existing conference participants, provided they are present before the remote ringback of the new participant starts. - `enabled` boolean: Flag indicating whether ringback generation is enabled. Cannot be `true` when `connectOnEarlyMedia` is `true`. - `role` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611Role: Represents the role of the call inside the conference. - `type` 'DEFAULT' | 'ADVISOR' | 'MONITOR' | 'LISTENER' | 'AUDITOR' ## Response `200` Call added. - C18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fcConferenceAndCall - `conference` C18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fcConference - `id` string: Unique conference ID. - `name` string: Conference name, requested or autogenerated on creation. - `participants` C18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fcParticipant[]: The list of conference participants. - `callId` string: Participant call ID. - `endpoint` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611CallEndpoint, required: Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls. - `type` 'PHONE' | 'SIP' | 'WEBRTC' | 'VIBER' | 'WHATSAPP' | 'WEBSOCKET' - `state` 'JOINING' | 'JOINED' | 'LEFT': Participant state. - `joinTime` string, date-time: Date and time when the participant has joined. - `leaveTime` string, date-time: Date and time when the participant has left. - `media` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611MediaProperties - `audio` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611AudioMediaProperties: Audio media properties. - `muted` boolean: Indicates whether the end user can speak. - `userMuted` boolean: Indicates whether the end user muted himself. - `deaf` boolean: Indicates whether the end user can hear. - `video` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611VideoMediaProperties: Video media properties. - `camera` boolean: Indicates whether there is a video feed. - `screenShare` boolean: Indicates whether the end user is sharing their screen. - `blind` boolean: Indicates whether the end user can receive remote videos. - `role` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611Role: Represents the role of the call inside the conference. - `type` 'DEFAULT' | 'ADVISOR' | 'MONITOR' | 'LISTENER' | 'AUDITOR' - `callsConfigurationId` string: Calls Configuration ID. - `platform` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611Platform: Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management). - `entityId` string: Required to use entity in a send request for outbound traffic. Returned in notification events. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management). - `applicationId` string: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management). - `call` 431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153fCall - `id` string: Unique call ID. - `endpoint` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611CallEndpoint, required: Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls. - `type` 'PHONE' | 'SIP' | 'WEBRTC' | 'VIBER' | 'WHATSAPP' | 'WEBSOCKET' - `from` string: Caller ID. - `to` string: Callee ID. - `direction` 'INBOUND' | 'OUTBOUND': Call direction. - `state` 'CALLING' | 'RINGING' | 'PRE_ESTABLISHED' | 'ESTABLISHED' | 'FINISHED' | 'FAILED' | 'CANCELLED' | 'NO_ANSWER' | 'BUSY': Call state. - `media` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611MediaProperties - `audio` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611AudioMediaProperties: Audio media properties. - `muted` boolean: Indicates whether the end user can speak. - `userMuted` boolean: Indicates whether the end user muted himself. - `deaf` boolean: Indicates whether the end user can hear. - `video` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611VideoMediaProperties: Video media properties. - `camera` boolean: Indicates whether there is a video feed. - `screenShare` boolean: Indicates whether the end user is sharing their screen. - `blind` boolean: Indicates whether the end user can receive remote videos. - `startTime` string, date-time: Date and time for when the call has been created. - `answerTime` string, date-time: Date and time for when the call has been answered. - `endTime` string, date-time: Date and time for when the call has been finished. - `parentCallId` string: Parent call ID. - `machineDetection` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611MachineDetectionProperties: Properties of the events that provide Answering Machine Detection result. - `detectionResult` 'HUMAN' | 'MACHINE': Detected class during analysis of the call. Always returns either HUMAN or MACHINE. Use confidenceRating for a finer grained analysis result - `confidenceRating` object: A map representing the confidence rating for each detection class. The key is a tag indicating the detection class, and the value is a float between `0.0` and `1.0` representing the confidence rating. Possible classes are: `HUMAN`, `MACHINE`, `MUSIC`, `RINGING`, `NOISE`, `SILENCE` and `OTHER`. Each class confidence rating is independent from the other, thereby the sum of all confidence values may not equal 1.0. - `customData` object: Custom data. - `ringDuration` integer: Ringing duration in seconds. - `callsConfigurationId` string: Current calls configuration ID. - `platform` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611Platform: Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management). - `entityId` string: Required to use entity in a send request for outbound traffic. Returned in notification events. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management). - `applicationId` string: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management). - `conferenceId` string: Current conference ID. - `customData` object: Custom data. - `dialogId` string: Dialog ID. - `externalId` string: Client defined call ID. ## Other responses - `400`: Bad request - `401`: Unauthorized - `403`: Forbidden - `404`: Conference or application not found. - `429`: Too many requests - `500`: Internal Server Error --- [API](https://skmtc.dev/infobip/apis/infobip-openapi-specification.md) - [All operations](https://skmtc.dev/infobip/apis/infobip-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/infobip/apis/infobip-openapi-specification/revisions/9dcbbaf902de?raw)