Evo Voice

<back to all web services

NewFlowMessage

The following routes are available for this service:
All Verbs/flows/message
"use strict";
export class Value {
    /** @param {{boolValue?:boolean,stringValue?:string,numberValue?:number,listValue?:Struct[],structValue?:Struct}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?boolean} */
    boolValue;
    /** @type {string} */
    stringValue;
    /** @type {?number} */
    numberValue;
    /** @type {Struct[]} */
    listValue;
    /** @type {Struct} */
    structValue;
}
class Dictionary {}
export class Struct extends Dictionary {
    constructor(init) { super(init); Object.assign(this, init) }
}
export class NewFlowMessage {
    /** @param {{endpointId?:string,sessionParameters?:Struct,fromAddress?:string,toAddress?:string,identity?:string,displayName?:string,messageUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The ID of the endpoint that received the message */
    endpointId;
    /**
     * @type {Struct}
     * @description The session values */
    sessionParameters;
    /**
     * @type {string}
     * @description The from address */
    fromAddress;
    /**
     * @type {string}
     * @description The to address */
    toAddress;
    /**
     * @type {string}
     * @description The identity of the sender */
    identity;
    /**
     * @type {string}
     * @description The display name of the sender (will default to identity if not specified */
    displayName;
    /**
     * @type {string}
     * @description The URL to call when replies need to be sent back */
    messageUrl;
}
/** @typedef {number} */
export var CacheControl;
(function (CacheControl) {
    CacheControl[CacheControl["None"] = 0] = "None"
    CacheControl[CacheControl["Public"] = 1] = "Public"
    CacheControl[CacheControl["Private"] = 2] = "Private"
    CacheControl[CacheControl["MustRevalidate"] = 4] = "MustRevalidate"
    CacheControl[CacheControl["NoCache"] = 8] = "NoCache"
    CacheControl[CacheControl["NoStore"] = 16] = "NoStore"
    CacheControl[CacheControl["NoTransform"] = 32] = "NoTransform"
    CacheControl[CacheControl["ProxyRevalidate"] = 64] = "ProxyRevalidate"
})(CacheControl || (CacheControl = {}));
/** @typedef {number} */
export var RequestAttributes;
(function (RequestAttributes) {
    RequestAttributes[RequestAttributes["None"] = 0] = "None"
    RequestAttributes[RequestAttributes["Localhost"] = 1] = "Localhost"
    RequestAttributes[RequestAttributes["LocalSubnet"] = 2] = "LocalSubnet"
    RequestAttributes[RequestAttributes["External"] = 4] = "External"
    RequestAttributes[RequestAttributes["Secure"] = 8] = "Secure"
    RequestAttributes[RequestAttributes["InSecure"] = 16] = "InSecure"
    RequestAttributes[RequestAttributes["AnySecurityMode"] = 24] = "AnySecurityMode"
    RequestAttributes[RequestAttributes["HttpHead"] = 32] = "HttpHead"
    RequestAttributes[RequestAttributes["HttpGet"] = 64] = "HttpGet"
    RequestAttributes[RequestAttributes["HttpPost"] = 128] = "HttpPost"
    RequestAttributes[RequestAttributes["HttpPut"] = 256] = "HttpPut"
    RequestAttributes[RequestAttributes["HttpDelete"] = 512] = "HttpDelete"
    RequestAttributes[RequestAttributes["HttpPatch"] = 1024] = "HttpPatch"
    RequestAttributes[RequestAttributes["HttpOptions"] = 2048] = "HttpOptions"
    RequestAttributes[RequestAttributes["HttpOther"] = 4096] = "HttpOther"
    RequestAttributes[RequestAttributes["AnyHttpMethod"] = 8160] = "AnyHttpMethod"
    RequestAttributes[RequestAttributes["OneWay"] = 8192] = "OneWay"
    RequestAttributes[RequestAttributes["Reply"] = 16384] = "Reply"
    RequestAttributes[RequestAttributes["AnyCallStyle"] = 24576] = "AnyCallStyle"
    RequestAttributes[RequestAttributes["Soap11"] = 32768] = "Soap11"
    RequestAttributes[RequestAttributes["Soap12"] = 65536] = "Soap12"
    RequestAttributes[RequestAttributes["Xml"] = 131072] = "Xml"
    RequestAttributes[RequestAttributes["Json"] = 262144] = "Json"
    RequestAttributes[RequestAttributes["Jsv"] = 524288] = "Jsv"
    RequestAttributes[RequestAttributes["ProtoBuf"] = 1048576] = "ProtoBuf"
    RequestAttributes[RequestAttributes["Csv"] = 2097152] = "Csv"
    RequestAttributes[RequestAttributes["Html"] = 4194304] = "Html"
    RequestAttributes[RequestAttributes["Jsonl"] = 8388608] = "Jsonl"
    RequestAttributes[RequestAttributes["MsgPack"] = 16777216] = "MsgPack"
    RequestAttributes[RequestAttributes["FormatOther"] = 33554432] = "FormatOther"
    RequestAttributes[RequestAttributes["AnyFormat"] = 67076096] = "AnyFormat"
    RequestAttributes[RequestAttributes["Http"] = 67108864] = "Http"
    RequestAttributes[RequestAttributes["MessageQueue"] = 134217728] = "MessageQueue"
    RequestAttributes[RequestAttributes["Tcp"] = 268435456] = "Tcp"
    RequestAttributes[RequestAttributes["Grpc"] = 536870912] = "Grpc"
    RequestAttributes[RequestAttributes["EndpointOther"] = 1073741824] = "EndpointOther"
    RequestAttributes[RequestAttributes["AnyEndpoint"] = 2080374784] = "AnyEndpoint"
    RequestAttributes[RequestAttributes["InProcess"] = -2147483648] = "InProcess"
    RequestAttributes[RequestAttributes["InternalNetworkAccess"] = -2147483645] = "InternalNetworkAccess"
    RequestAttributes[RequestAttributes["AnyNetworkAccessType"] = -2147483641] = "AnyNetworkAccessType"
    RequestAttributes[RequestAttributes["Any"] = -1] = "Any"
})(RequestAttributes || (RequestAttributes = {}));
export class HttpResult {
    /** @param {{responseText?:string,responseStream?:string,fileInfo?:FileInfo,virtualFile?:IVirtualFile,contentType?:string,headers?:{ [index:string]: string; },cookies?:Cookie[],eTag?:string,age?:string,maxAge?:string,expires?:string,lastModified?:string,cacheControl?:CacheControl,resultScope?:Func<IDisposable>,allowsPartialResponse?:boolean,options?:{ [index:string]: string; },status?:number,statusCode?:HttpStatusCode,statusDescription?:string,response?:Object,responseFilter?:IContentTypeWriter,requestContext?:IRequest,view?:string,template?:string,paddingLength?:number,isPartialRequest?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    responseText;
    /** @type {string} */
    responseStream;
    /** @type {FileInfo} */
    fileInfo;
    /** @type {IVirtualFile} */
    virtualFile;
    /** @type {string} */
    contentType;
    /** @type {{ [index:string]: string; }} */
    headers;
    /** @type {Cookie[]} */
    cookies;
    /** @type {string} */
    eTag;
    /** @type {?string} */
    age;
    /** @type {?string} */
    maxAge;
    /** @type {?string} */
    expires;
    /** @type {?string} */
    lastModified;
    /** @type {CacheControl} */
    cacheControl;
    /** @type {Func<IDisposable>} */
    resultScope;
    /** @type {boolean} */
    allowsPartialResponse;
    /** @type {{ [index:string]: string; }} */
    options;
    /** @type {number} */
    status;
    /** @type {HttpStatusCode} */
    statusCode;
    /** @type {string} */
    statusDescription;
    /** @type {Object} */
    response;
    /** @type {IContentTypeWriter} */
    responseFilter;
    /** @type {IRequest} */
    requestContext;
    /** @type {string} */
    view;
    /** @type {string} */
    template;
    /** @type {number} */
    paddingLength;
    /** @type {boolean} */
    isPartialRequest;
}

JavaScript NewFlowMessage DTOs

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

HTTP + OTHER

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

POST /flows/message HTTP/1.1 
Host: team.evovoice.io 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"endpointId":"String","fromAddress":"String","toAddress":"String","identity":"String","displayName":"String","messageUrl":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}