Requires any of the roles: | Manager, SystemAdministrator |
POST | /sessions/outgoing |
---|
import Foundation
import ServiceStack
/**
* 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 class NewOutgoingSession : IPost, Codable
{
/**
* 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 var flowId:String
/**
* The E164 number to dial, e.g. +18144043093
*/
// @ApiMember(Description="The E164 number to dial, e.g. +18144043093")
public var numberToDial:String
/**
* 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 var callerId:String
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>