Requires any of the roles: | Manager, SystemAdministrator |
POST | /sessions/outgoing |
---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"flowId":"String","numberToDial":"String","callerId":"String"}