| Requires any of the roles: | Manager, SystemAdministrator |
| POST | /sessions/outgoing |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
# @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.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NewOutgoingSession(IPost):
"""
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.
"""
# @ApiMember(Description="The ID of the flow to use. This flow will be executed as soon as the call is answered.")
flow_id: Optional[str] = None
"""
The ID of the flow to use. This flow will be executed as soon as the call is answered.
"""
# @ApiMember(Description="The E164 number to dial, e.g. +18144043093")
number_to_dial: Optional[str] = None
"""
The E164 number to dial, e.g. +18144043093
"""
# @ApiMember(Description="The Caller ID to use. This must be the E164 number of an owned phone number")
caller_id: Optional[str] = None
"""
The Caller ID to use. This must be the E164 number of an owned phone number
"""
Python NewOutgoingSession DTOs
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>