From 627c85ed48ec69809ae2e225c371ad621122ceb4 Mon Sep 17 00:00:00 2001 From: balzack Date: Mon, 29 May 2023 21:20:32 -0700 Subject: [PATCH] updating html documentation --- doc/swagger.html | 6676 +++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 6328 insertions(+), 348 deletions(-) diff --git a/doc/swagger.html b/doc/swagger.html index fd40bd23..d2b93139 100644 --- a/doc/swagger.html +++ b/doc/swagger.html @@ -748,11 +748,14 @@ }, "disabled" : { "type" : "boolean" + }, + "seal" : { + "type" : "string" } } }; defs["AccountStatus"] = { - "required" : [ "disabled", "forwardingAddress", "searchable", "storageAvailable", "storageUsed" ], + "required" : [ "disabled", "forwardingAddress", "pushEnabled", "searchable", "storageAvailable", "storageUsed" ], "type" : "object", "properties" : { "disabled" : { @@ -771,6 +774,18 @@ }, "searchable" : { "type" : "boolean" + }, + "pushEnabled" : { + "type" : "boolean" + }, + "sealable" : { + "type" : "boolean" + }, + "seal" : { + "$ref" : "#/components/schemas/Seal" + }, + "enableIce" : { + "type" : "boolean" } } }; @@ -901,6 +916,37 @@ "enum" : [ "pending", "processing", "importing", "ready", "error" ] } } +}; + defs["Call"] = { + "required" : [ "calleeToken", "callerToken", "cardId", "id", "keepAlive" ], + "type" : "object", + "properties" : { + "id" : { + "type" : "string" + }, + "cardId" : { + "type" : "string" + }, + "callerToken" : { + "type" : "string" + }, + "calleeToken" : { + "type" : "string" + }, + "keepAlive" : { + "type" : "integer", + "format" : "int32" + }, + "iceUrl" : { + "type" : "string" + }, + "iceUsername" : { + "type" : "string" + }, + "icePassword" : { + "type" : "string" + } + } }; defs["Card"] = { "required" : [ "data", "id", "revision" ], @@ -1008,6 +1054,9 @@ "node" : { "type" : "string" }, + "seal" : { + "type" : "string" + }, "revision" : { "type" : "integer", "format" : "int64" @@ -1101,20 +1150,20 @@ "members" : { "type" : "array", "items" : { - "type" : "string" + "$ref" : "#/components/schemas/ChannelMember" } } } }; - defs["ChannelMembers"] = { + defs["ChannelMember"] = { "required" : [ "members" ], "type" : "object", "properties" : { - "members" : { - "type" : "array", - "items" : { - "type" : "string" - } + "member" : { + "type" : "string" + }, + "pushEnabled" : { + "type" : "boolean" } } }; @@ -1200,6 +1249,9 @@ "version" : { "type" : "string" }, + "seal" : { + "type" : "string" + }, "node" : { "type" : "string" } @@ -1334,11 +1386,14 @@ }, "node" : { "type" : "string" + }, + "seal" : { + "type" : "string" } } }; defs["LoginAccess"] = { - "required" : [ "appToken", "created", "guid" ], + "required" : [ "appToken", "created", "guid", "pushSupported" ], "type" : "object", "properties" : { "guid" : { @@ -1350,6 +1405,9 @@ "created" : { "type" : "integer", "format" : "int64" + }, + "pushSupported" : { + "type" : "boolean" } } }; @@ -1375,6 +1433,21 @@ }, "keyType" : { "type" : "string" + }, + "pushSupported" : { + "type" : "boolean" + }, + "enableIce" : { + "type" : "boolean" + }, + "iceUrl" : { + "type" : "string" + }, + "iceUsername" : { + "type" : "string" + }, + "icePassword" : { + "type" : "string" } } }; @@ -1405,6 +1478,10 @@ "type" : "integer", "format" : "int64" }, + "seal" : { + "type" : "string", + "format" : "base64 encoded data" + }, "version" : { "type" : "string" }, @@ -1456,6 +1533,53 @@ "format" : "int64" } } +}; + defs["Ring"] = { + "required" : [ "callId", "calleeToken", "index" ], + "type" : "object", + "properties" : { + "callId" : { + "type" : "string" + }, + "calleeToken" : { + "type" : "string" + }, + "index" : { + "type" : "integer", + "format" : "int32" + }, + "iceUrl" : { + "type" : "string" + }, + "iceUsername" : { + "type" : "string" + }, + "icePassword" : { + "type" : "string" + } + } +}; + defs["Seal"] = { + "required" : [ "privateKeyEncrypted", "publicKey", "salt" ], + "type" : "object", + "properties" : { + "passwordSalt" : { + "type" : "string", + "format" : "hex encoded data" + }, + "privateKeyIv" : { + "type" : "string", + "format" : "hex encoded data" + }, + "privateKeyEncrypted" : { + "type" : "string", + "format" : "base64 encoded data" + }, + "publicKey" : { + "type" : "string", + "format" : "base64 encoded data" + } + } }; defs["SignedData"] = { "required" : [ "guid", "messageType", "timestamp", "value" ], @@ -1664,6 +1788,12 @@
  • removeAccountApp
    • +
  • + removeAgentToken +
    • +
  • + setAccountAccess +
  • setAccountAuthentication
    • @@ -1676,9 +1806,15 @@
  • setAccountNode
    • +
  • + setAccountNotification +
  • setAccountSeachable
    • +
  • + setAccountSeal +
  • API Methods - Admin
  • addNodeAccount @@ -1813,6 +1949,9 @@
  • setProfileRevision
    • +
  • + setPushEvent +
  • setViewRevision
    • @@ -1826,6 +1965,9 @@
  • addChannelTopicAsset
    • +
  • + addChannelTopicBlock +
  • addChannelTopicTag
    • @@ -1838,6 +1980,9 @@
  • getChannelDetail
    • +
  • + getChannelNotifications +
  • getChannelSubjectField
    • @@ -1886,6 +2031,9 @@
  • setChannelGroup
    • +
  • + setChannelNotifications +
  • setChannelSubject
    • @@ -1899,9 +2047,6 @@ setChannelTopicTagSubject
  • API Methods - Profile
    • -
  • - deleteProfile -
  • getProfile
    • @@ -1911,6 +2056,9 @@
  • getProfileMessage
    • +
  • + removeProfile +
  • setProfile
    • @@ -1918,9 +2066,28 @@ setProfileImage
  • API Methods - Status
    • +
  • + activity +
  • status
    • +
  • API Methods - Talk
    • +
  • + addCall +
    • +
  • + addRing +
    • +
  • + endCall +
    • +
  • + keepCall +
    • +
  • + signal +
    • @@ -1934,7 +2101,7 @@ +
    @@ -7254,7 +8533,17 @@ except ApiException as e:
    +
    + + + + + +
    Query parameters
    + + + + + + + + +
    NameDescription
    agent + + +
    +
    +
    + + String + + +
    + agent token +
    +
    +
    +
    +
    + +

    Responses

    +

    Status: 201 - success

    + +
      +
    + +
    +
    + +

    Status: 401 - permission denied

    + +
      +
    + +
    +
    + +

    Status: 405 - failed to confirm

    + +
      +
    + +
    +
    + +

    Status: 500 - internal server error

    + +
      +
    + +
    +
    + +
    +
    +
    @@ -7932,6 +9538,323 @@ except ApiException as e:
    +
    +
    +
    +

    setAccountSeal

    +

    +
    +
    +
    +

    +

    Set sealing key for account.

    +

    +
    + 
    /account/seal
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    + 
    curl -X PUT\
+-H "Content-Type: application/json"\
+"//account/seal?agent="
    +
    +
    + 
    import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.AccountApi;
+
+import java.io.File;
+import java.util.*;
+
+public class AccountApiExample {
+
+    public static void main(String[] args) {
+        
+        AccountApi apiInstance = new AccountApi();
+        Seal body = ; // Seal | 
+        String agent = agent_example; // String | agent token
+        try {
+            apiInstance.setAccountSeal(body, agent);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling AccountApi#setAccountSeal");
+            e.printStackTrace();
+        }
+    }
+}
    +
    + +
    + 
    import io.swagger.client.api.AccountApi;
+
+public class AccountApiExample {
+
+    public static void main(String[] args) {
+        AccountApi apiInstance = new AccountApi();
+        Seal body = ; // Seal | 
+        String agent = agent_example; // String | agent token
+        try {
+            apiInstance.setAccountSeal(body, agent);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling AccountApi#setAccountSeal");
+            e.printStackTrace();
+        }
+    }
+}
    +
    + +
    + 
    Seal *body = ; //  (optional)
+String *agent = agent_example; // agent token (optional)
+
+AccountApi *apiInstance = [[AccountApi alloc] init];
+
+[apiInstance setAccountSealWith:body
+    agent:agent
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
    +
    + +
    + 
    var DataBag = require('data_bag');
+
+var api = new DataBag.AccountApi()
+var opts = { 
+  'body':  // {{Seal}} 
+  'agent': agent_example // {{String}} agent token
+};
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.setAccountSeal(opts, callback);
+
    +
    + + +
    + 
    using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class setAccountSealExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new AccountApi();
+            var body = new Seal(); // Seal |  (optional) 
+            var agent = agent_example;  // String | agent token (optional) 
+
+            try
+            {
+                apiInstance.setAccountSeal(body, agent);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling AccountApi.setAccountSeal: " + e.Message );
+            }
+        }
+    }
+}
+
    +
    + +
    + 
    <?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiAccountApi();
+$body = ; // Seal | 
+$agent = agent_example; // String | agent token
+
+try {
+    $api_instance->setAccountSeal($body, $agent);
+} catch (Exception $e) {
+    echo 'Exception when calling AccountApi->setAccountSeal: ', $e->getMessage(), PHP_EOL;
+}
+?>
    +
    + +
    + 
    use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::AccountApi;
+
+my $api_instance = WWW::SwaggerClient::AccountApi->new();
+my $body = WWW::SwaggerClient::Object::Seal->new(); # Seal | 
+my $agent = agent_example; # String | agent token
+
+eval { 
+    $api_instance->setAccountSeal(body => $body, agent => $agent);
+};
+if ($@) {
+    warn "Exception when calling AccountApi->setAccountSeal: $@\n";
+}
    +
    + +
    + 
    from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.AccountApi()
+body =  # Seal |  (optional)
+agent = agent_example # String | agent token (optional)
+
+try: 
+    api_instance.set_account_seal(body=body, agent=agent)
+except ApiException as e:
+    print("Exception when calling AccountApi->setAccountSeal: %s\n" % e)
    +
    +
    + +

    Parameters

    + + + +
    Body parameters
    + + + + + + + + +
    NameDescription
    body + + + +
    +
    + + +
    Query parameters
    + + + + + + + + +
    NameDescription
    agent + + +
    +
    +
    + + String + + +
    + agent token +
    +
    +
    +
    +
    + +

    Responses

    +

    Status: 201 - success

    + +
      +
    + +
    +
    + +

    Status: 401 - permission denied

    + +
      +
    + +
    +
    + +

    Status: 410 - account disabled

    + +
      +
    + +
    +
    + +

    Status: 500 - internal server error

    + +
      +
    + +
    +
    + +
    +
    +

    Admin

    @@ -8191,7 +10114,17 @@ except ApiException as e:
    +
    + + + + + +
    Query parameters
    + + + + + + + + +
    NameDescription
    contact* + + +
    +
    +
    + + String + + +
    + contact token +
    +
    +
    + Required +
    +
    +
    +
    + +

    Responses

    +

    Status: 200 - event set

    + +
      +
    + +
    +
    + +

    Status: 401 - not authorized

    + +
      +
    + +
    +
    + +

    Status: 410 - account disabled

    + +
      +
    + +
    +
    + +

    Status: 500 - internal server error

    + +
      +
    + +
    +
    + + +
    +
    @@ -23466,7 +26057,16 @@ except ApiException as e:
    +
    + + + + + + +

    Responses

    +

    Status: 201 - success

    + + + +
    +
    +
    + +
    + +
    +
    + +

    Status: 401 - permission denied

    + +
      +
    + +
    +
    + +

    Status: 404 - channel not found

    + +
      +
    + +
    +
    + +

    Status: 406 - storage limit reached

    + +
      +
    + +
    +
    + +

    Status: 410 - account disabled

    + +
      +
    + +
    +
    + +

    Status: 500 - internal server error

    + +
      +
    + +
    +
    + +
    +
    +
    @@ -24711,7 +27764,16 @@ except ApiException as e:
    +
    + +
    +
    + +

    Status: 401 - permission denied

    + + + +
    +
    + +

    Status: 404 - field, channel not found

    + + + +
    +
    + +

    Status: 410 - account disabled

    + + + +
    +
    + +

    Status: 500 - internal server error

    + + + +
    +
    + + + +
    @@ -26100,7 +29584,18 @@ except ApiException as e:
    +
    + + + + + +
    Query parameters
    + + + + + + + + + + + +
    NameDescription
    agent* + + +
    +
    +
    + + String + + +
    + access token granted to agent +
    +
    +
    + Required +
    +
    +
    +
    contact* + + +
    +
    +
    + + String + + +
    + access token granted to contact +
    +
    +
    + Required +
    +
    +
    +
    + +

    Responses

    +

    Status: 200 - success

    + +
      +
    + +
    +
    + +

    Status: 401 - permission denied

    + +
      +
    + +
    +
    + +

    Status: 404 - field, channel not found

    + +
      +
    + +
    +
    + +

    Status: 410 - account disabled

    + +
      +
    + +
    +
    + +

    Status: 500 - internal server error

    + +
      +
    + +
    +
    + +
    +
    +
    @@ -32117,7 +36190,16 @@ except ApiException as e:
    +
    + + + + + +
    Query parameters
    + + + + + + + + + + + +
    NameDescription
    agent* + + +
    +
    +
    + + String + + +
    + agent token +
    +
    +
    + Required +
    +
    +
    +
    cardId* + + +
    +
    +
    + + String + + +
    + id of card to call +
    +
    +
    + Required +
    +
    +
    +
    + +

    Responses

    +

    Status: 201 - entry created

    + + + +
    +
    +
    + +
    + +
    +
    + +

    Status: 401 - permission denied

    + +
      +
    + +
    +
    + +

    Status: 410 - account disabled

    + +
      +
    + +
    +
    + +

    Status: 500 - internal server error

    + +
      +
    + +
    +
    + +
    +
    +
    +
    +
    +
    +

    addRing

    +

    +
    +
    +
    +

    +

    Create a ring event in contact

    +

    +
    + 
    /talk/ring
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    + 
    curl -X POST\
+-H "Content-Type: application/json"\
+"//talk/ring?contact=&calleeToken=&index="
    +
    +
    + 
    import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.TalkApi;
+
+import java.io.File;
+import java.util.*;
+
+public class TalkApiExample {
+
+    public static void main(String[] args) {
+        
+        TalkApi apiInstance = new TalkApi();
+        String contact = contact_example; // String | contact token
+        String calleeToken = calleeToken_example; // String | token for the contact to connect with
+        Integer index = 56; // Integer | index of current ring
+        Ring body = ; // Ring | 
+        try {
+            apiInstance.addRing(contact, calleeToken, index, body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling TalkApi#addRing");
+            e.printStackTrace();
+        }
+    }
+}
    +
    + +
    + 
    import io.swagger.client.api.TalkApi;
+
+public class TalkApiExample {
+
+    public static void main(String[] args) {
+        TalkApi apiInstance = new TalkApi();
+        String contact = contact_example; // String | contact token
+        String calleeToken = calleeToken_example; // String | token for the contact to connect with
+        Integer index = 56; // Integer | index of current ring
+        Ring body = ; // Ring | 
+        try {
+            apiInstance.addRing(contact, calleeToken, index, body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling TalkApi#addRing");
+            e.printStackTrace();
+        }
+    }
+}
    +
    + +
    + 
    String *contact = contact_example; // contact token
+String *calleeToken = calleeToken_example; // token for the contact to connect with
+Integer *index = 56; // index of current ring
+Ring *body = ; //  (optional)
+
+TalkApi *apiInstance = [[TalkApi alloc] init];
+
+[apiInstance addRingWith:contact
+    calleeToken:calleeToken
+    index:index
+    body:body
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
    +
    + +
    + 
    var DataBag = require('data_bag');
+
+var api = new DataBag.TalkApi()
+var contact = contact_example; // {{String}} contact token
+var calleeToken = calleeToken_example; // {{String}} token for the contact to connect with
+var index = 56; // {{Integer}} index of current ring
+var opts = { 
+  'body':  // {{Ring}} 
+};
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.addRing(contactcalleeTokenindex, opts, callback);
+
    +
    + + +
    + 
    using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class addRingExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new TalkApi();
+            var contact = contact_example;  // String | contact token
+            var calleeToken = calleeToken_example;  // String | token for the contact to connect with
+            var index = 56;  // Integer | index of current ring
+            var body = new Ring(); // Ring |  (optional) 
+
+            try
+            {
+                apiInstance.addRing(contact, calleeToken, index, body);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling TalkApi.addRing: " + e.Message );
+            }
+        }
+    }
+}
+
    +
    + +
    + 
    <?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiTalkApi();
+$contact = contact_example; // String | contact token
+$calleeToken = calleeToken_example; // String | token for the contact to connect with
+$index = 56; // Integer | index of current ring
+$body = ; // Ring | 
+
+try {
+    $api_instance->addRing($contact, $calleeToken, $index, $body);
+} catch (Exception $e) {
+    echo 'Exception when calling TalkApi->addRing: ', $e->getMessage(), PHP_EOL;
+}
+?>
    +
    + +
    + 
    use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::TalkApi;
+
+my $api_instance = WWW::SwaggerClient::TalkApi->new();
+my $contact = contact_example; # String | contact token
+my $calleeToken = calleeToken_example; # String | token for the contact to connect with
+my $index = 56; # Integer | index of current ring
+my $body = WWW::SwaggerClient::Object::Ring->new(); # Ring | 
+
+eval { 
+    $api_instance->addRing(contact => $contact, calleeToken => $calleeToken, index => $index, body => $body);
+};
+if ($@) {
+    warn "Exception when calling TalkApi->addRing: $@\n";
+}
    +
    + +
    + 
    from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.TalkApi()
+contact = contact_example # String | contact token
+calleeToken = calleeToken_example # String | token for the contact to connect with
+index = 56 # Integer | index of current ring
+body =  # Ring |  (optional)
+
+try: 
+    api_instance.add_ring(contact, calleeToken, index, body=body)
+except ApiException as e:
+    print("Exception when calling TalkApi->addRing: %s\n" % e)
    +
    +
    + +

    Parameters

    + + + +
    Body parameters
    + + + + + + + + +
    NameDescription
    body + + + +
    +
    + + +
    Query parameters
    + + + + + + + + + + + + + + +
    NameDescription
    contact* + + +
    +
    +
    + + String + + +
    + contact token +
    +
    +
    + Required +
    +
    +
    +
    calleeToken* + + +
    +
    +
    + + String + + +
    + token for the contact to connect with +
    +
    +
    + Required +
    +
    +
    +
    index* + + +
    +
    +
    + + Integer + + + (int32) + + +
    + index of current ring +
    +
    +
    + Required +
    +
    +
    +
    + +

    Responses

    +

    Status: 201 - entry created

    + +
      +
    + +
    +
    + +

    Status: 401 - permission denied

    + +
      +
    + +
    +
    + +

    Status: 410 - account disabled

    + +
      +
    + +
    +
    + +

    Status: 500 - internal server error

    + +
      +
    + +
    +
    + +
    +
    +
    +
    +
    +
    +

    endCall

    +

    +
    +
    +
    +

    +

    terminte sepecified call

    +

    +
    + 
    /talk/calls/{callId}
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    + 
    curl -X DELETE\
+"//talk/calls/{callId}?agent=&contact="
    +
    +
    + 
    import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.TalkApi;
+
+import java.io.File;
+import java.util.*;
+
+public class TalkApiExample {
+
+    public static void main(String[] args) {
+        
+        TalkApi apiInstance = new TalkApi();
+        String callId = callId_example; // String | id of call to end
+        String agent = agent_example; // String | agent token
+        String contact = contact_example; // String | contact token
+        try {
+            apiInstance.endCall(callId, agent, contact);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling TalkApi#endCall");
+            e.printStackTrace();
+        }
+    }
+}
    +
    + +
    + 
    import io.swagger.client.api.TalkApi;
+
+public class TalkApiExample {
+
+    public static void main(String[] args) {
+        TalkApi apiInstance = new TalkApi();
+        String callId = callId_example; // String | id of call to end
+        String agent = agent_example; // String | agent token
+        String contact = contact_example; // String | contact token
+        try {
+            apiInstance.endCall(callId, agent, contact);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling TalkApi#endCall");
+            e.printStackTrace();
+        }
+    }
+}
    +
    + +
    + 
    String *callId = callId_example; // id of call to end
+String *agent = agent_example; // agent token (optional)
+String *contact = contact_example; // contact token (optional)
+
+TalkApi *apiInstance = [[TalkApi alloc] init];
+
+[apiInstance endCallWith:callId
+    agent:agent
+    contact:contact
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
    +
    + +
    + 
    var DataBag = require('data_bag');
+
+var api = new DataBag.TalkApi()
+var callId = callId_example; // {{String}} id of call to end
+var opts = { 
+  'agent': agent_example, // {{String}} agent token
+  'contact': contact_example // {{String}} contact token
+};
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.endCall(callId, opts, callback);
+
    +
    + + +
    + 
    using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class endCallExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new TalkApi();
+            var callId = callId_example;  // String | id of call to end
+            var agent = agent_example;  // String | agent token (optional) 
+            var contact = contact_example;  // String | contact token (optional) 
+
+            try
+            {
+                apiInstance.endCall(callId, agent, contact);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling TalkApi.endCall: " + e.Message );
+            }
+        }
+    }
+}
+
    +
    + +
    + 
    <?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiTalkApi();
+$callId = callId_example; // String | id of call to end
+$agent = agent_example; // String | agent token
+$contact = contact_example; // String | contact token
+
+try {
+    $api_instance->endCall($callId, $agent, $contact);
+} catch (Exception $e) {
+    echo 'Exception when calling TalkApi->endCall: ', $e->getMessage(), PHP_EOL;
+}
+?>
    +
    + +
    + 
    use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::TalkApi;
+
+my $api_instance = WWW::SwaggerClient::TalkApi->new();
+my $callId = callId_example; # String | id of call to end
+my $agent = agent_example; # String | agent token
+my $contact = contact_example; # String | contact token
+
+eval { 
+    $api_instance->endCall(callId => $callId, agent => $agent, contact => $contact);
+};
+if ($@) {
+    warn "Exception when calling TalkApi->endCall: $@\n";
+}
    +
    + +
    + 
    from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.TalkApi()
+callId = callId_example # String | id of call to end
+agent = agent_example # String | agent token (optional)
+contact = contact_example # String | contact token (optional)
+
+try: 
+    api_instance.end_call(callId, agent=agent, contact=contact)
+except ApiException as e:
+    print("Exception when calling TalkApi->endCall: %s\n" % e)
    +
    +
    + +

    Parameters

    + +
    Path parameters
    + + + + + + + + +
    NameDescription
    callId* + + +
    +
    +
    + + String + + +
    + id of call to end +
    +
    +
    + Required +
    +
    +
    +
    + + + + +
    Query parameters
    + + + + + + + + + + + +
    NameDescription
    agent + + +
    +
    +
    + + String + + +
    + agent token +
    +
    +
    +
    +
    contact + + +
    +
    +
    + + String + + +
    + contact token +
    +
    +
    +
    +
    + +

    Responses

    +

    Status: 200 - successful operation

    + +
      +
    + +
    +
    + +

    Status: 401 - permission denied

    + +
      +
    + +
    +
    + +

    Status: 410 - account disabled

    + +
      +
    + +
    +
    + +

    Status: 500 - internal server error

    + +
      +
    + +
    +
    + +
    +
    +
    +
    +
    +
    +

    keepCall

    +

    +
    +
    +
    +

    +

    extend keep alive on specified call

    +

    +
    + 
    /talk/calls/{callId}
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    + 
    curl -X PUT\
+"//talk/calls/{callId}?agent="
    +
    +
    + 
    import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.TalkApi;
+
+import java.io.File;
+import java.util.*;
+
+public class TalkApiExample {
+
+    public static void main(String[] args) {
+        
+        TalkApi apiInstance = new TalkApi();
+        String agent = agent_example; // String | agent token
+        String callId = callId_example; // String | id of call to keep alive
+        try {
+            apiInstance.keepCall(agent, callId);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling TalkApi#keepCall");
+            e.printStackTrace();
+        }
+    }
+}
    +
    + +
    + 
    import io.swagger.client.api.TalkApi;
+
+public class TalkApiExample {
+
+    public static void main(String[] args) {
+        TalkApi apiInstance = new TalkApi();
+        String agent = agent_example; // String | agent token
+        String callId = callId_example; // String | id of call to keep alive
+        try {
+            apiInstance.keepCall(agent, callId);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling TalkApi#keepCall");
+            e.printStackTrace();
+        }
+    }
+}
    +
    + +
    + 
    String *agent = agent_example; // agent token
+String *callId = callId_example; // id of call to keep alive
+
+TalkApi *apiInstance = [[TalkApi alloc] init];
+
+[apiInstance keepCallWith:agent
+    callId:callId
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
    +
    + +
    + 
    var DataBag = require('data_bag');
+
+var api = new DataBag.TalkApi()
+var agent = agent_example; // {{String}} agent token
+var callId = callId_example; // {{String}} id of call to keep alive
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.keepCall(agent, callId, callback);
+
    +
    + + +
    + 
    using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class keepCallExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new TalkApi();
+            var agent = agent_example;  // String | agent token
+            var callId = callId_example;  // String | id of call to keep alive
+
+            try
+            {
+                apiInstance.keepCall(agent, callId);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling TalkApi.keepCall: " + e.Message );
+            }
+        }
+    }
+}
+
    +
    + +
    + 
    <?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiTalkApi();
+$agent = agent_example; // String | agent token
+$callId = callId_example; // String | id of call to keep alive
+
+try {
+    $api_instance->keepCall($agent, $callId);
+} catch (Exception $e) {
+    echo 'Exception when calling TalkApi->keepCall: ', $e->getMessage(), PHP_EOL;
+}
+?>
    +
    + +
    + 
    use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::TalkApi;
+
+my $api_instance = WWW::SwaggerClient::TalkApi->new();
+my $agent = agent_example; # String | agent token
+my $callId = callId_example; # String | id of call to keep alive
+
+eval { 
+    $api_instance->keepCall(agent => $agent, callId => $callId);
+};
+if ($@) {
+    warn "Exception when calling TalkApi->keepCall: $@\n";
+}
    +
    + +
    + 
    from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.TalkApi()
+agent = agent_example # String | agent token
+callId = callId_example # String | id of call to keep alive
+
+try: 
+    api_instance.keep_call(agent, callId)
+except ApiException as e:
+    print("Exception when calling TalkApi->keepCall: %s\n" % e)
    +
    +
    + +

    Parameters

    + +
    Path parameters
    + + + + + + + + +
    NameDescription
    callId* + + +
    +
    +
    + + String + + +
    + id of call to keep alive +
    +
    +
    + Required +
    +
    +
    +
    + + + + +
    Query parameters
    + + + + + + + + +
    NameDescription
    agent* + + +
    +
    +
    + + String + + +
    + agent token +
    +
    +
    + Required +
    +
    +
    +
    + +

    Responses

    +

    Status: 200 - successful operation

    + +
      +
    + +
    +
    + +

    Status: 401 - permission denied

    + +
      +
    + +
    +
    + +

    Status: 404 - call not found

    + +
      +
    + +
    +
    + +

    Status: 406 - call has already expired or closed

    + +
      +
    + +
    +
    + +

    Status: 410 - account disabled

    + +
      +
    + +
    +
    + +

    Status: 500 - internal server error

    + +
      +
    + +
    +
    + +
    +
    +
    +
    +
    +
    +

    signal

    +

    +
    +
    +
    +

    +

    Websocket endpoint for coordinating webrtc conversation

    +

    +
    + 
    /talk/signal
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    + 
    curl -X GET\
+"//talk/signal"
    +
    +
    + 
    import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.TalkApi;
+
+import java.io.File;
+import java.util.*;
+
+public class TalkApiExample {
+
+    public static void main(String[] args) {
+        
+        TalkApi apiInstance = new TalkApi();
+        try {
+            apiInstance.signal();
+        } catch (ApiException e) {
+            System.err.println("Exception when calling TalkApi#signal");
+            e.printStackTrace();
+        }
+    }
+}
    +
    + +
    + 
    import io.swagger.client.api.TalkApi;
+
+public class TalkApiExample {
+
+    public static void main(String[] args) {
+        TalkApi apiInstance = new TalkApi();
+        try {
+            apiInstance.signal();
+        } catch (ApiException e) {
+            System.err.println("Exception when calling TalkApi#signal");
+            e.printStackTrace();
+        }
+    }
+}
    +
    + +
    + 
    
+TalkApi *apiInstance = [[TalkApi alloc] init];
+
+[apiInstance signalWithCompletionHandler: 
+              ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
    +
    + +
    + 
    var DataBag = require('data_bag');
+
+var api = new DataBag.TalkApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.signal(callback);
+
    +
    + + +
    + 
    using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class signalExample
+    {
+        public void main()
+        {
+
+            var apiInstance = new TalkApi();
+
+            try
+            {
+                apiInstance.signal();
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling TalkApi.signal: " + e.Message );
+            }
+        }
+    }
+}
+
    +
    + +
    + 
    <?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\ApiTalkApi();
+
+try {
+    $api_instance->signal();
+} catch (Exception $e) {
+    echo 'Exception when calling TalkApi->signal: ', $e->getMessage(), PHP_EOL;
+}
+?>
    +
    + +
    + 
    use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::TalkApi;
+
+my $api_instance = WWW::SwaggerClient::TalkApi->new();
+
+eval { 
+    $api_instance->signal();
+};
+if ($@) {
+    warn "Exception when calling TalkApi->signal: $@\n";
+}
    +
    + +
    + 
    from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.TalkApi()
+
+try: 
+    api_instance.signal()
+except ApiException as e:
+    print("Exception when calling TalkApi->signal: %s\n" % e)
    +
    +
    + +

    Parameters

    + + + + + + +

    Responses

    +

    Status: 200 - Awaiting token

    + +
      +
    + +
    +
    + +
    +
    +
    +