Evo Voice

<back to all web services

NewOutgoingSession

Create a new outgoing call and process it with the specified flow. This can only be used for voice sessions. If no caller ID is specified, we will use a random one.

Requires Authentication
Requires any of the roles:Manager, SystemAdministrator
The following routes are available for this service:
POST/sessions/outgoing
"use strict";
export class NewOutgoingSession {
    /** @param {{flowId?:string,numberToDial?:string,callerId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The ID of the flow to use. This flow will be executed as soon as the call is answered. */
    flowId;
    /**
     * @type {string}
     * @description The E164 number to dial, e.g. +18144043093 */
    numberToDial;
    /**
     * @type {string}
     * @description The Caller ID to use. This must be the E164 number of an owned phone number */
    callerId;
}

JavaScript NewOutgoingSession DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /sessions/outgoing HTTP/1.1 
Host: team.evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<NewOutgoingSession xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Sessions">
  <CallerId>String</CallerId>
  <FlowId>String</FlowId>
  <NumberToDial>String</NumberToDial>
</NewOutgoingSession>