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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * 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.
    */
    @Api(Description="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.")
    public static class NewOutgoingSession implements IPost
    {
        /**
        * The ID of the flow to use. This flow will be executed as soon as the call is answered.
        */
        @ApiMember(Description="The ID of the flow to use. This flow will be executed as soon as the call is answered.")
        public String flowId = null;

        /**
        * The E164 number to dial, e.g. +18144043093
        */
        @ApiMember(Description="The E164 number to dial, e.g. +18144043093")
        public String numberToDial = null;

        /**
        * The Caller ID to use. This must be the E164 number of an owned phone number
        */
        @ApiMember(Description="The Caller ID to use. This must be the E164 number of an owned phone number")
        public String callerId = null;
        
        public String getFlowId() { return flowId; }
        public NewOutgoingSession setFlowId(String value) { this.flowId = value; return this; }
        public String getNumberToDial() { return numberToDial; }
        public NewOutgoingSession setNumberToDial(String value) { this.numberToDial = value; return this; }
        public String getCallerId() { return callerId; }
        public NewOutgoingSession setCallerId(String value) { this.callerId = value; return this; }
    }

}

Java NewOutgoingSession DTOs

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

HTTP + JSV

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: evovoice.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	flowId: String,
	numberToDial: String,
	callerId: String
}