Evo Voice

<back to all web services

SendMessage

Requires Authentication
Required role:User
The following routes are available for this service:
POST/sessions/{sessionId}/messages
All Verbs/messages
import 'package:servicestack/servicestack.dart';

enum MessageDirections
{
    Incoming,
    Outgoing,
}

class MessageInfo implements IConvertible
{
    String? id;
    String? accountId;
    String? customerId;
    String? endpointId;
    String? endpointDisplayName;
    String? date;
    MessageDirections? direction;
    String? otherAddress;
    String? sender;
    String? text;
    bool? isUnread;

    MessageInfo({this.id,this.accountId,this.customerId,this.endpointId,this.endpointDisplayName,this.date,this.direction,this.otherAddress,this.sender,this.text,this.isUnread});
    MessageInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        accountId = json['accountId'];
        customerId = json['customerId'];
        endpointId = json['endpointId'];
        endpointDisplayName = json['endpointDisplayName'];
        date = json['date'];
        direction = JsonConverters.fromJson(json['direction'],'MessageDirections',context!);
        otherAddress = json['otherAddress'];
        sender = json['sender'];
        text = json['text'];
        isUnread = json['isUnread'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'accountId': accountId,
        'customerId': customerId,
        'endpointId': endpointId,
        'endpointDisplayName': endpointDisplayName,
        'date': date,
        'direction': JsonConverters.toJson(direction,'MessageDirections',context!),
        'otherAddress': otherAddress,
        'sender': sender,
        'text': text,
        'isUnread': isUnread
    };

    getTypeName() => "MessageInfo";
    TypeContext? context = _ctx;
}

class SendMessage implements IConvertible
{
    /**
    * The ID of the session you want to post a message to. Specify either this or EndpointId+ToAddress
    */
    // @ApiMember(Description="The ID of the session you want to post a message to. Specify either this or EndpointId+ToAddress")
    String? sessionId;

    /**
    * The ID of the endpoint you want to post a message to. Typically the ID of a phone number endpoint. Not used if SessionId is specified
    */
    // @ApiMember(Description="The ID of the endpoint you want to post a message to. Typically the ID of a phone number endpoint. Not used if SessionId is specified")
    String? endpointId;

    /**
    * The address of the party you want to send a message to, e.g. +15556667777. Not used if SessionId is specified
    */
    // @ApiMember(Description="The address of the party you want to send a message to, e.g. +15556667777. Not used if SessionId is specified")
    String? toAddress;

    /**
    * The body of the message
    */
    // @ApiMember(Description="The body of the message")
    String? body;

    SendMessage({this.sessionId,this.endpointId,this.toAddress,this.body});
    SendMessage.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        sessionId = json['sessionId'];
        endpointId = json['endpointId'];
        toAddress = json['toAddress'];
        body = json['body'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'sessionId': sessionId,
        'endpointId': endpointId,
        'toAddress': toAddress,
        'body': body
    };

    getTypeName() => "SendMessage";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'evovoice.io', types: <String, TypeInfo> {
    'MessageDirections': TypeInfo(TypeOf.Enum, enumValues:MessageDirections.values),
    'MessageInfo': TypeInfo(TypeOf.Class, create:() => MessageInfo()),
    'SendMessage': TypeInfo(TypeOf.Class, create:() => SendMessage()),
});

Dart SendMessage DTOs

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

HTTP + JSON

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

POST /sessions/{sessionId}/messages HTTP/1.1 
Host: evovoice.io 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"sessionId":"String","endpointId":"String","toAddress":"String","body":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":"String","accountId":"String","customerId":"String","endpointId":"String","endpointDisplayName":"String","date":"String","direction":"Incoming","otherAddress":"String","sender":"String","text":"String","isUnread":false}