API Reference

The Synthetix Application Programming Platform or ‘SYNAPPS’ is organized around REST. Our API has predictable, resource-oriented URLs, and error codes to indicate API errors. We use built-in HTTP features, like HTTP headers and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website's client-side code). JSON is returned by all API responses.

To make the APIs as approachable as possible, we are currently working on a ‘Test Rig’ so you can play with the resources using your keys and your data before writing any code.

Authentication

Access to all SYNAPPS resources require authentication with API consumer and application keys. These are available only to registered and authorised users and are tied to a particular view onto your knowledge base and product set.

Authenticate your account when using the API by including your API consumer and application keys in the head. You can manage your API keys in our control panel. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such GitHub, client-side code, and so forth.

Authentication to the API is performed via HTTP Head. Provide your API consumer and application keys as the ‘APPLICATIONKEY’ and ‘CONSUMERKEY’ headers. You do not need to provide a password.

You have the ability to enforce origin access identity to restrict access so only your website or application can use your keys. This is to prevent unauthorised applications from using your key and consuming your quota or access your data. You can enforce origin access identity using a list of URLs or IPs within the Control Panel.

Products and Resources

SYNAPPs resources are categorised by the type of product they relate most directly to, i.e. as external knowledge resources, internal information resources, live chat resources, analytical resources etc. The resources that you will have access to will be based on the commercial agreement between yourselves and Synthetix. You will only be able to use resources for the types of products that you are entitled to on the basis of the commercial arrangement. Should you require access to any additional resources outside those granted on the basis of your commercial arrangement, you will need to contact your Synthetix account manager.

Usage Quotas

Usage quotas are based on individual calls and are calculated per application. Not all resource calls are included in the quota calculation. We will provide usage quotas in accordance with your commercial arrangement and product set in use. Usage quotas are calculated on a monthly basis, and will reset on the first day of each new month. Should your application approach your usage quota, you will be notified in good time. Notifications will repeat regularly as you approach your limit. We are able to allow a small amount of overrun on a discretionary basis, subject to commercial arrangements, but we reserve the right to enforce and change individual application usage quotas, particularly if we perceive abuse.

Rate Limiting

Certain of our resources are rate limited. This means that some methods will only allow a certain number of requests over a set period of time. Rate limits are per application rather than per user or session. We reserve the right to adjust these rate limits to restrict the possibility of abuse by one client at the expense of high quality services provided to others. If a rate limit is exceeded, SYNAPPS will return an error code. Should you find your application exceeding your allocated rate limits, it is your responsibility to throttle back your requests accordingly.

Sessions

Most SYNAPPS resources require a session to be initiated prior to proceeding. Successful initiation of a session will return an encrypted token that should be passed as a parameter for most of our resources. Session tokens enable us to enforce additional security on fundamental resources, pass encrypted information and allows logging and analysis of the activity of a specific user session. A session token must be generated for each unique user and will expire 2 hours after generation.

We provide an additional resource to allow checking of whether an existing session is still valid.

Errors

We use SYNAPPS error codes to indicate any failure of an API request. The error code key can be found in the documentation. In general, codes in the 1xx range indicate general errors, codes in the 2xx range indicate a credential error that failed given the information provided (e.g., a required key was omitted, invalid keys were provided, etc.), and codes in the 3xx range indicate a data error, (e.g., missing data files or database information etc.).

Versioning and change logging

When we make changes to API resources, we document these on https://twitter.com/SynthetixAPIS. We recommend that all users of SYNAPPS resources subscribe to this Twitter account to ensure they stay abreast of any updates. Deprecated resources will be retained but not updated.

Backwards incompatible changes to resources will trigger the release of a new version of the API. The release of a new version will be publicised in the documentation and on the Twitter feed.

Restrictions and Limitations

You cannot interfere with, modify or disable any features, functionality or security controls of the SYNAPPS API resources and/or associated Synthetix services. You may not defeat, avoid, bypass, remove, deactivate or otherwise circumvent any protection mechanisms of the SYNAPPS API resources and/or associated Synthetix services. You may not reverse engineer, decompile, disassemble or derive source code, underlying ideas, algorithms, structure or organizational form from any SYNAPPS API resource and/or associated Synthetix service.

You are solely responsible (and Synthetix has no responsibility or liability of any kind), for the content, development, operation, or maintenance of your SYNAPPS applications. You will be solely responsible for the technical installation and operation of your SYNAPPS applications, for creating and displaying information and content on, through or within your SYNAPPs applications; for ensuring that your SYNAPPS applications do not violate or infringe the Intellectual Property Rights of any third party; and for ensuring that your SYNAPPS applications do not contain or introduce Malicious Software into the API, or any data stored and/or reported on using associated Synthetix services or transmitted using SYNAPPS API resources.

You must respect and comply with the technical and policy-implemented limitations of the API and the restrictions Synthetix designs or informs you of in accessing or using the API or designing and implementing SYNAPPS applications. Without limiting the foregoing, you may not violate any explicit rate limitations on calling or otherwise utilizing the API resources.

To the extent you develop or implement SYNAPPS applications that transmit or otherwise use or access the API to transmit data outside the Synthetix architecture, you will be responsible for any required notification to or consent of agents or end users that their data will be thus transmitted. Synthetix is not responsible for the privacy, security or integrity of data to the extent it is transmitted outside the Synthetix architecture by you or your applications using the SYNAPPS API resources.

analytics/missedchats

POST

https://api.syn-finity.com/1.1/analytics/missedchats

Example API Request

Resource information

Returns a list of chats that have been missed. If a skill is passed in, it will only return missed chats for that skill.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • skill

    string

    Optional

    The skill you want to filter the missed chats by.

    Example billing

Example Request

[
  
]

Example Response

[
  {
    "title":"Do I need to think about my users?",
    "label":"e2",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Hmmm - Yes. When answering a question, consider the position of the user as a person who is looking to buy from you. Try to help him. If for example, you..."
  },
  {
    "title":"Can you link from one FAQ to another?",
    "label":"b4",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Oh yes, indeed we can. We can use links between one FAQ and any other in the database. Like this."
  },
  {
    "title":"Can I have a red box?",
    "label":"d9",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Yes. This answer could have been made better. See how."
  },
  {
    "title":"I would like to return my boxes",
    "label":"d16",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Oh. Well, as long as you havent touched them, sniffed them or let your ant near them, if you drive to a spot 2 miles north west of Wisbech, and wait there..."
  },
  {
    "title":"Can I download the FAQ data for this view?",
    "label":"qed034a",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Apparently not. This is updated."
  },
  {
    "title":"How can I order a box?",
    "label":"d7",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Ordering a box is easy.Simply send us a postcard with your name, address and order requirements and staple a cheque to the postcard. That should be fine."
  },
  {
    "title":"How many views can I add to one question?",
    "label":"qed013",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Lots and lots and lots. As many as you have front ends! This question shows against two out of the the three views in this agent."
  },
  {
    "title":"Who are Boxes N Stuff?",
    "label":"a1",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"We are a non-existent stationery company that Synthetix use to show clients how to (and how not to) write answers."
  },
  {
    "title":"I have bought 24 of your small green boxes and they are neither as green as I had expected nor as small as I need",
    "label":"d14",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"This is not really an appropriate FAQ. Too long. Too specific and very unlikely to ever be asked! It could be generalised to the boxes are not as expected..."
  },
  {
    "title":"Can I squash two questions into one?",
    "label":"c3",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Dont make one question out of two questions? For example, What colour boxes do you offer and how can I order them should not be one question. It is too..."
  },
  {
    "title":"My boxes are wrong",
    "label":"d18",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Oh dear. Perhaps you can use them for something else.If not, feel free to use our return process."
  },
  {
    "title":"The boxes I bought are not as expected",
    "label":"d15",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Oh dear. Never mind."
  }
]

Expected Errors

  • Error Code

    Summary

HTTP Example

	
    POST /1.1/analytics/missedchats HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    skill=billing
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/analytics/missedchats?skill=billing"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/analytics/missedchats?skill=billing",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/analytics/missedchats",
        dataType:"json",
        crossDomain:true,
        data:"skill=billing",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "skill=billing"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/analytics/missedchats", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/analytics/missedchats");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "skill=billing");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/analytics/missedchats");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "skill=billing", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/analytics/missedchats")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("skill=billing")
      .asString();

	
	

analytics/faqs

POST

https://api.syn-finity.com/1.1/analytics/faqs

Example API Request

Resource information

Returns the most popular FAQs for a particular logging ID with associated labels. Options are for the most popular questions across the view either across the knowledge base or by category or category/subcategory. If you do not specify a subcategory it will return the most popular questions for the category specified. If you do not specify a category OR a subcategory, the most popular questions across the whole knowledge base will be returned.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • category

    string

    Optional

    The category for which you want to return results.

    Example billing

  • subcategory

    string

    Optional

    The subcategory for which you want to return results.

    Example VAT

Example Request

[
  
]

Example Response

[
  {
    "title":"Do I need to think about my users?",
    "label":"e2",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Hmmm - Yes. When answering a question, consider the position of the user as a person who is looking to buy from you. Try to help him. If for example, you..."
  },
  {
    "title":"Can you link from one FAQ to another?",
    "label":"b4",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Oh yes, indeed we can. We can use links between one FAQ and any other in the database. Like this."
  },
  {
    "title":"Can I have a red box?",
    "label":"d9",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Yes. This answer could have been made better. See how."
  },
  {
    "title":"I would like to return my boxes",
    "label":"d16",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Oh. Well, as long as you havent touched them, sniffed them or let your ant near them, if you drive to a spot 2 miles north west of Wisbech, and wait there..."
  },
  {
    "title":"Can I download the FAQ data for this view?",
    "label":"qed034a",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Apparently not. This is updated."
  },
  {
    "title":"How can I order a box?",
    "label":"d7",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Ordering a box is easy.Simply send us a postcard with your name, address and order requirements and staple a cheque to the postcard. That should be fine."
  },
  {
    "title":"How many views can I add to one question?",
    "label":"qed013",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Lots and lots and lots. As many as you have front ends! This question shows against two out of the the three views in this agent."
  },
  {
    "title":"Who are Boxes N Stuff?",
    "label":"a1",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"We are a non-existent stationery company that Synthetix use to show clients how to (and how not to) write answers."
  },
  {
    "title":"I have bought 24 of your small green boxes and they are neither as green as I had expected nor as small as I need",
    "label":"d14",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"This is not really an appropriate FAQ. Too long. Too specific and very unlikely to ever be asked! It could be generalised to the boxes are not as expected..."
  },
  {
    "title":"Can I squash two questions into one?",
    "label":"c3",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Dont make one question out of two questions? For example, What colour boxes do you offer and how can I order them should not be one question. It is too..."
  },
  {
    "title":"My boxes are wrong",
    "label":"d18",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Oh dear. Perhaps you can use them for something else.If not, feel free to use our return process."
  },
  {
    "title":"The boxes I bought are not as expected",
    "label":"d15",
    "pubDate":"Thu, 12 Nov 2015 03:04:17 GMT",
    "category":"train1",
    "description":"Oh dear. Never mind."
  }
]

Expected Errors

  • Error Code

    Summary

  • 154

    NO DATA

  • 124

    FAILED TO CONNECT

HTTP Example

	
    POST /1.1/analytics/faqs HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    category=billing&subcategory=VAT
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/analytics/faqs?category=billing&subcategory=VAT"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/analytics/faqs?category=billing&subcategory=VAT",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/analytics/faqs",
        dataType:"json",
        crossDomain:true,
        data:"category=billing&subcategory=VAT",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "category=billing&subcategory=VAT"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/analytics/faqs", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/analytics/faqs");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "category=billing&subcategory=VAT");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/analytics/faqs");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "category=billing&subcategory=VAT", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/analytics/faqs")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("category=billing&subcategory=VAT")
      .asString();

	
	

environment/variables

GET

https://api.syn-finity.com/1.1/environment/variables

Example API Request

Resource information

Retrieves all available environmental variables currently set in the associated session, defined by the token sent.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • token

    string

    Required

    This must be included in all valid calls to the node API. It includes session identification information to enable user activities to be tied together in a 'conversation' as well as validation information. A token must be generated for each unique user and will expire 2 hours after generation.

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

Example Request

{
  "token":"97B25C61-19FF-XXXX-3824-CAA8D691B010"
}

Example Response

{
  "**ZORK**":{
    "thanks":{
      "values":[
        {
          "id":"R170",
          "value":"Thank you, that's great.",
          "order":2
        },
        {
          "id":"R171",
          "value":"Thank you very much.",
          "order":3
        },
        {
          "id":"R251",
          "value":"Great, thanks for that",
          "order":5
        }
      ],
      "order":"random"
    },
    "pricerange":{
      "values":[
        {
          "id":"R38",
          "value":null,
          "order":1
        }
      ],
      "order":null
    },
    "retry":{
      "values":[
        {
          "id":"R187",
          "value":true,
          "order":1
        },
        {
          "id":"R188",
          "value":false,
          "order":2
        }
      ],
      "order":null
    }
  },
  "channel":15,
  "container":{
    "trigger":"IVA_Inpage",
    "open":true
  },
  "goal":"2",
  "gu_id":"d14243ff-b8df-4a90-ab7d-c962f62cc90e",
  "histoire":[
    {
      "identifier":"85329124-d0c6-c73f-c799-a91135ae6d4a",
      "sender":"iva",
      "journey_selection":null,
      "time":1492787527492,
      "message":"

Hello. My name is Lisa. I'm a virtual agent, here to answer your questions and help you find the information you need about Yarrabilba.<\/p>

How should I address you?<\/p><\/p>", "status":"zk" } ], "journey_id":"journey_37eec9ac-d54b-4614-8bfc-a374b323ee6f", "journeystatus":1, "key":"name", "lastnodevisited":"N4", "location":[ ], "offset":1, "placeholder":"Type your name here", "session":"051229CE-E174-1707-2771-8653CE22BD13", "validation":"name", "validation_failure":"

Are you sure that's your name? Would you mind just confirming it?<\/p>", "value":"{{firstname}}", "views":{ "from":"YAR", "to":"YAR" } }

Expected Errors

  • Error Code

    Summary

HTTP Example

	
    GET /1.1/environment/variables HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    token=97B25C61-19FF-XXXX-3824-CAA8D691B010
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/environment/variables?token=97B25C61-19FF-XXXX-3824-CAA8D691B010"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/environment/variables?token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/environment/variables",
        dataType:"json",
        crossDomain:true,
        data:"token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "token=97B25C61-19FF-XXXX-3824-CAA8D691B010"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/environment/variables", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/environment/variables");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "token=97B25C61-19FF-XXXX-3824-CAA8D691B010");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/environment/variables");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "token=97B25C61-19FF-XXXX-3824-CAA8D691B010", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/environment/variables")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("token=97B25C61-19FF-XXXX-3824-CAA8D691B010")
      .asString();

	
	

environment/variables

POST

https://api.syn-finity.com/1.1/environment/variables

Example API Request

Resource information

Creates a new environmental variable in the associated session, as defined by the token. The variable is set using a key-value pair, with the key as the new variable name and the value as the value that the variable will be set to. Variable values can be single or multi-dimensional by sending in a string or an array respectively. On creating a new variable the updated list of environmental variables associated with this session will be returned.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • token

    string

    Required

    This must be included in all valid calls to the node API. It includes session identification information to enable user activities to be tied together in a 'conversation' as well as validation information. A token must be generated for each unique user and will expire 2 hours after generation.

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

Example Request

{
  "token":"97B25C61-19FF-XXXX-3824-CAA8D691B010",
  "goal":2
}

Example Response

{
  "**ZORK**":{
    "thanks":{
      "values":[
        {
          "id":"R170",
          "value":"Thank you, that's great.",
          "order":2
        },
        {
          "id":"R171",
          "value":"Thank you very much.",
          "order":3
        },
        {
          "id":"R251",
          "value":"Great, thanks for that",
          "order":5
        }
      ],
      "order":"random"
    },
    "pricerange":{
      "values":[
        {
          "id":"R38",
          "value":null,
          "order":1
        }
      ],
      "order":null
    },
    "retry":{
      "values":[
        {
          "id":"R187",
          "value":true,
          "order":1
        },
        {
          "id":"R188",
          "value":false,
          "order":2
        }
      ],
      "order":null
    }
  },
  "channel":15,
  "container":{
    "trigger":"IVA_Inpage",
    "open":true
  },
  "goal":"2",
  "gu_id":"d14243ff-b8df-4a90-ab7d-c962f62cc90e",
  "histoire":[
    {
      "identifier":"85329124-d0c6-c73f-c799-a91135ae6d4a",
      "sender":"iva",
      "journey_selection":null,
      "time":1492787527492,
      "message":"

Hello. My name is Lisa. I'm a virtual agent, here to answer your questions and help you find the information you need about Yarrabilba.<\/p>

How should I address you?<\/p><\/p>", "status":"zk" } ], "journey_id":"journey_37eec9ac-d54b-4614-8bfc-a374b323ee6f", "journeystatus":1, "key":"name", "lastnodevisited":"N4", "location":[ ], "offset":1, "placeholder":"Type your name here", "session":"051229CE-E174-1707-2771-8653CE22BD13", "validation":"name", "validation_failure":"

Are you sure that's your name? Would you mind just confirming it?<\/p>", "value":"{{firstname}}", "views":{ "from":"YAR", "to":"YAR" } }

Expected Errors

  • Error Code

    Summary

HTTP Example

	
    POST /1.1/environment/variables HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    token=97B25C61-19FF-XXXX-3824-CAA8D691B010
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/environment/variables?token=97B25C61-19FF-XXXX-3824-CAA8D691B010"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/environment/variables?token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/environment/variables",
        dataType:"json",
        crossDomain:true,
        data:"token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "token=97B25C61-19FF-XXXX-3824-CAA8D691B010"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/environment/variables", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/environment/variables");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "token=97B25C61-19FF-XXXX-3824-CAA8D691B010");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/environment/variables");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "token=97B25C61-19FF-XXXX-3824-CAA8D691B010", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/environment/variables")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("token=97B25C61-19FF-XXXX-3824-CAA8D691B010")
      .asString();

	
	

environment/variables

PATCH

https://api.syn-finity.com/1.1/environment/variables

Example API Request

Resource information

Updates an environmental variable in the associated session, as defined by the token. The variable is set using a key-value pair, with the key as the variable name and the value as the value that the variable will be set to. Variable values can be single or multi-dimensional by sending in a string or an array respectively. On updating a variable the updated list of environmental variables associated with this session will be returned.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • token

    string

    Required

    This must be included in all valid calls to the node API. It includes session identification information to enable user activities to be tied together in a 'conversation' as well as validation information. A token must be generated for each unique user and will expire 2 hours after generation.

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

Example Request

{
  "token":"97B25C61-19FF-XXXX-3824-CAA8D691B010",
  "goal":2
}

Example Response

{
  "**ZORK**":{
    "thanks":{
      "values":[
        {
          "id":"R170",
          "value":"Thank you, that's great.",
          "order":2
        },
        {
          "id":"R171",
          "value":"Thank you very much.",
          "order":3
        },
        {
          "id":"R251",
          "value":"Great, thanks for that",
          "order":5
        }
      ],
      "order":"random"
    },
    "pricerange":{
      "values":[
        {
          "id":"R38",
          "value":null,
          "order":1
        }
      ],
      "order":null
    },
    "retry":{
      "values":[
        {
          "id":"R187",
          "value":true,
          "order":1
        },
        {
          "id":"R188",
          "value":false,
          "order":2
        }
      ],
      "order":null
    }
  },
  "channel":15,
  "container":{
    "trigger":"IVA_Inpage",
    "open":true
  },
  "goal":"2",
  "gu_id":"d14243ff-b8df-4a90-ab7d-c962f62cc90e",
  "histoire":[
    {
      "identifier":"85329124-d0c6-c73f-c799-a91135ae6d4a",
      "sender":"iva",
      "journey_selection":null,
      "time":1492787527492,
      "message":"

Hello. My name is Lisa. I'm a virtual agent, here to answer your questions and help you find the information you need about Yarrabilba.<\/p>

How should I address you?<\/p><\/p>", "status":"zk" } ], "journey_id":"journey_37eec9ac-d54b-4614-8bfc-a374b323ee6f", "journeystatus":1, "key":"name", "lastnodevisited":"N4", "location":[ ], "offset":1, "placeholder":"Type your name here", "session":"051229CE-E174-1707-2771-8653CE22BD13", "validation":"name", "validation_failure":"

Are you sure that's your name? Would you mind just confirming it?<\/p>", "value":"{{firstname}}", "views":{ "from":"YAR", "to":"YAR" } }

Expected Errors

  • Error Code

    Summary

HTTP Example

	
    PATCH /1.1/environment/variables HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    token=97B25C61-19FF-XXXX-3824-CAA8D691B010
	
	

CURL Example

	
    curl --request PATCH
    --url "https://api.syn-finity.com/1.1/environment/variables?token=97B25C61-19FF-XXXX-3824-CAA8D691B010"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/environment/variables?token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "PATCH",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"PATCH",
        url:"https://api.syn-finity.com/1.1/environment/variables",
        dataType:"json",
        crossDomain:true,
        data:"token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "token=97B25C61-19FF-XXXX-3824-CAA8D691B010"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("PATCH", "/1.1/environment/variables", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/environment/variables");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "token=97B25C61-19FF-XXXX-3824-CAA8D691B010");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/environment/variables");
    var request = new RestRequest(Method.PATCH);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "token=97B25C61-19FF-XXXX-3824-CAA8D691B010", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.PATCH("https://api.syn-finity.com/1.1/environment/variables")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("token=97B25C61-19FF-XXXX-3824-CAA8D691B010")
      .asString();

	
	

external/ad_serve

POST

https://api.syn-finity.com/1.1/external/ad_serve

Example API Request

Resource information

Depending on the mode passed in, returns any advertising banners set against a particular category / subcategory / view combination, registers that the ad has been served (impressions), or registers that the ad has been clicked on by the user (hits).

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • mode

    string

    Required

    The mode being used. Options are 'list' (returns a list of banner ads against a given category and/or subcategory), 'impression' (registers the ad impression, returns a '1' if the impression is successfully registered) or 'click' (registers a user click on the advert, returns a '1' if the click is successfully registered).

    Example list

  • category

    string

    Required

    The category for which you wish to return banner ad results. Only required in list mode.

    Example Bills and Accounts

  • subcategory

    string

    Optional

    The subcategory for which you wish to return banner ad results. Note that if the banner ads have been set up at the subcategory level, this will be required to return any meaninfgul results.

    Example Logging in

  • ad_id

    string

    Required

    ad_id is returned with the list of adverts in 'list' mode. Required in 'impression' or 'click' modes.

    Example 3237383053796

Example Request

[
  
]

Example Response

[
  
]

Expected Errors

  • Error Code

    Summary

  • 303

    NO AD DATA

  • 304

    NO AD DATA

  • 124

    FAILED TO CONNECT

  • 136

    NO RESULTS

  • 135

    MODE NOT RECOGNIZED

HTTP Example

	
    POST /1.1/external/ad_serve HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    mode=list&category=Bills+and+Accounts&subcategory=Logging+in&ad_id=3237383053796
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/external/ad_serve?mode=list&category=Bills+and+Accounts&subcategory=Logging+in&ad_id=3237383053796"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/ad_serve?mode=list&category=Bills+and+Accounts&subcategory=Logging+in&ad_id=3237383053796",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/external/ad_serve",
        dataType:"json",
        crossDomain:true,
        data:"mode=list&category=Bills+and+Accounts&subcategory=Logging+in&ad_id=3237383053796",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "mode=list&category=Bills+and+Accounts&subcategory=Logging+in&ad_id=3237383053796"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/external/ad_serve", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/ad_serve");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "mode=list&category=Bills+and+Accounts&subcategory=Logging+in&ad_id=3237383053796");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/ad_serve");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "mode=list&category=Bills+and+Accounts&subcategory=Logging+in&ad_id=3237383053796", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/external/ad_serve")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("mode=list&category=Bills+and+Accounts&subcategory=Logging+in&ad_id=3237383053796")
      .asString();

	
	

external/all_faqs

GET

https://api.syn-finity.com/1.1/external/all_faqs

Example API Request

Resource information

Returns all the FAQs within the knowledge base, in order of popularity. Can be filtered to include just those FAQs within one category, or one subcategory. Thus will provide popular FAQs for any number of FAQs. The returned data will include total number of results, the number of hits against each FAQ and the view(s) for each FAQ.

  • Authentication

    True

  • Quota Controlled

    False

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • category

    string

    Optional

    The category for which you wish to retrieve the popular (or all) faqs.

    Example 'Answers'

  • subcategory

    string

    Optional

    The subcategory for which you wish to retrieve the popular (or all) faqs.

    Example 'Good Answers'

  • limitno

    integer

    Optional

    The number of FAQs you wish to retrieve. If left blank, the default is 20, if you wish to retrieve ALL faqs, this should be -1

    Example 20

  • limitdate

    integer

    Optional

    The number of days for which you wish the popularity to be checked. If left blank, the default is 7. We impose a maximum of 30 days

    Example 3

Example Request

{
  "category":"Answers",
  "limitno":"30"
}

Example Response

{
  "items":[
    {
      "label":"d9",
      "question":"Can I have a red box?",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"b5",
      "question":"Can you include bullet points in an answer?",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"g1",
      "question":"Can I embolden text in my answers?",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"h8",
      "question":"How does logging work in different views?",
      "pop":"0",
      "views":[
        "train3"
      ]
    },
    {
      "label":"qed047",
      "question":"Who is Adam Ashcroft?",
      "pop":"0",
      "views":[
        null
      ]
    },
    {
      "label":"h5",
      "question":"Can I have different ads running in different views?",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"qed006",
      "question":"Can I include tables in my answers?",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"b4",
      "question":"Can you link from one FAQ to another?",
      "pop":"0",
      "views":[
        null
      ]
    },
    {
      "label":"qed014",
      "question":"Can I add a question in more than one view at a time?",
      "pop":"0",
      "views":[
        null
      ]
    },
    {
      "label":"c5",
      "question":"Do I need to be  careful about my language?",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"h2",
      "question":"Can I run two faqtagents off one knowledge base?",
      "pop":"0",
      "views":[
        null
      ]
    },
    {
      "label":"h3",
      "question":"Can I have the same question in two different views?",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"e2",
      "question":"Do I need to think about my users?",
      "pop":"0",
      "views":[
        "train2"
      ]
    },
    {
      "label":"f2",
      "question":"Can I order a box online?",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"qed053",
      "question":"Who is Bob Smith",
      "pop":"0",
      "views":[
        null
      ]
    },
    {
      "label":"g3",
      "question":"How do I add in a hyperlink in my answer?",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"1002632620",
      "question":"Tell me about Sync Updates",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"1002632662",
      "question":"How do Ford My Touch Updates work?",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"1002706067",
      "question":"Ford Employment Verification",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"1000557749",
      "question":"My Ford Touch Guide",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"f1",
      "question":"Can I have a box like my brother's",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"c4",
      "question":"Can I include quite specific questions or should I generalise?",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"1002632503",
      "question":"Do you have any information on Ford Sync 3?",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"1002633602",
      "question":"What is the Ford Intelligent Access Key?",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"b2",
      "question":"Where does the URL I give you appear?",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"d16",
      "question":"I would like to return my boxes",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"qed005",
      "question":"Can I add images into answers?",
      "pop":"0",
      "views":[
        "train2"
      ]
    },
    {
      "label":"d14",
      "question":"I have bought 24 of your small green boxes and they are neither as green as I had expected nor as small as I need",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"1002706042",
      "question":"Tell me about careers At Ford",
      "pop":"0",
      "views":[
        "train1"
      ]
    },
    {
      "label":"e1a",
      "question":"Can I include questions that I can't answer?",
      "pop":"0",
      "views":[
        "train1"
      ]
    }
  ],
  "totalresults":30
}

Expected Errors

  • Error Code

    Summary

  • 165

    CATEGORY DOES NOT EXIST

  • 166

    CATEGORY AND SUBCATEGORY ARE INCOMPATIBLE

HTTP Example

	
    GET /1.1/external/all_faqs HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    category=%27Answers%27&subcategory=%27Good+Answers%27&limitno=20&limitdate=3
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/external/all_faqs?category=%27Answers%27&subcategory=%27Good+Answers%27&limitno=20&limitdate=3"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/all_faqs?category=%27Answers%27&subcategory=%27Good+Answers%27&limitno=20&limitdate=3",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/external/all_faqs",
        dataType:"json",
        crossDomain:true,
        data:"category=%27Answers%27&subcategory=%27Good+Answers%27&limitno=20&limitdate=3",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "category=%27Answers%27&subcategory=%27Good+Answers%27&limitno=20&limitdate=3"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/external/all_faqs", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/all_faqs");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "category=%27Answers%27&subcategory=%27Good+Answers%27&limitno=20&limitdate=3");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/all_faqs");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "category=%27Answers%27&subcategory=%27Good+Answers%27&limitno=20&limitdate=3", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/external/all_faqs")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("category=%27Answers%27&subcategory=%27Good+Answers%27&limitno=20&limitdate=3")
      .asString();

	
	

external/article

POST

https://api.syn-finity.com/1.1/external/article

Example API Request

Resource information

Returns the question (FAQ) and answer text, along with the contents of the URL field for the specified FAQ label. Optionally, any comments that are held against the article can be requested. This is essentially the 'answer' to the FAQ and can be styled up accordingly. For ratings purposes, the feedback questions and options, together with an answer ID are also returned, and these are a required parameter for the article rating resource, allowing user / article and rating to be tied together. Note that where a link is included in an article of the form (as in the example below synthetix:oq51, this is a link to a different FAQ either within or outside the specified view. This type of link will need to be handled in the same way as a selection from a results list, i.e. using the external/article resource to show the appropriate answer.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • label

    string

    Required

    The label of the FAQ for which to return the answer text (case sensitive).

    Example qed00001

  • userid

    string

    Required

    The name or ID you choose to use to identify users. If anonymous, a randomly generated number or string will work. This serves to tie user activity together in conversations. If a token is passed in with a valid user ID this will be used, otherwise, user ID should be passed in.

    Example 47583920957393

  • token

    string

    Required

    This must be included in all valid calls to the search API. It includes session identification information to enable user activities to be tied together in a 'conversation' as well as validation information. A token must be generated for each unique user and will expire 2 hours after generation.

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • query

    string

    Optional

    The query being searched against. For the most complete record of user activity, and MOST IMPORTANTLY, usable resolution statistics, it is best to include this.

    Example hosted

  • comments

    bool

    Optional

    Flags the search to return the list of comments against the article.

    Example 1

  • origin_url

    string

    Optional

    Allows the origin URL of the request to be logged against the request.

    Example http://trumpdonald.org

  • username

    string

    Required

    If a username is held against the session, this will be retrieved from the session. If not, should be passed in.

    Example Bob_the_builder

Example Request

{
  "label":"oq9",
  "userid":"47583920957393",
  "token":"97B25C61-19FF-XXXX-3824-CAA8D691B010"
}

Example Response

Expected Errors

  • Error Code

    Summary

  • 157

    NO RESULTS

  • 185

    LOGGING FAILURE

HTTP Example

	
    POST /1.1/external/article HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    label=qed00001&userid=47583920957393&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&query=hosted&comments=1&origin_url=http%3A%2F%2Ftrumpdonald.org&username=Bob_the_builder
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/external/article?label=qed00001&userid=47583920957393&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&query=hosted&comments=1&origin_url=http%3A%2F%2Ftrumpdonald.org&username=Bob_the_builder"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/article?label=qed00001&userid=47583920957393&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&query=hosted&comments=1&origin_url=http%3A%2F%2Ftrumpdonald.org&username=Bob_the_builder",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/external/article",
        dataType:"json",
        crossDomain:true,
        data:"label=qed00001&userid=47583920957393&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&query=hosted&comments=1&origin_url=http%3A%2F%2Ftrumpdonald.org&username=Bob_the_builder",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "label=qed00001&userid=47583920957393&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&query=hosted&comments=1&origin_url=http%3A%2F%2Ftrumpdonald.org&username=Bob_the_builder"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/external/article", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/article");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "label=qed00001&userid=47583920957393&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&query=hosted&comments=1&origin_url=http%3A%2F%2Ftrumpdonald.org&username=Bob_the_builder");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/article");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "label=qed00001&userid=47583920957393&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&query=hosted&comments=1&origin_url=http%3A%2F%2Ftrumpdonald.org&username=Bob_the_builder", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/external/article")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("label=qed00001&userid=47583920957393&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&query=hosted&comments=1&origin_url=http%3A%2F%2Ftrumpdonald.org&username=Bob_the_builder")
      .asString();

	
	

external/breadcrumb

POST

https://api.syn-finity.com/1.1/external/breadcrumb

Example API Request

Resource information

Records a new interaction within a given session.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • code

    string

    Required

    The logging code of the interaction

    Example 204

  • key

    string

    Required

    The details key associated with this interaction

    Example 29

  • value

    string

    Required

    The value to be assigned to this interaction.

    Example Thanks, what question can I help you with?

  • user

    string

    Required

    The origin of the interaction.

    Example iva

  • channel

    string

    Optional

    The channel that this interaction will be recorded against.

    Example 15

Example Request

{
  "code":"204",
  "key":"29",
  "value":"Thanks Henry, what question can I help you with?",
  "user":"iva",
  "channel":"15"
}

Example Response

[
  "true"
]

Expected Errors

  • Error Code

    Summary

HTTP Example

	
    POST /1.1/external/breadcrumb HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    code=204&key=29&value=Thanks%2C+what+question+can+I+help+you+with%3F&user=iva&channel=15
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/external/breadcrumb?code=204&key=29&value=Thanks%2C+what+question+can+I+help+you+with%3F&user=iva&channel=15"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/breadcrumb?code=204&key=29&value=Thanks%2C+what+question+can+I+help+you+with%3F&user=iva&channel=15",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/external/breadcrumb",
        dataType:"json",
        crossDomain:true,
        data:"code=204&key=29&value=Thanks%2C+what+question+can+I+help+you+with%3F&user=iva&channel=15",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "code=204&key=29&value=Thanks%2C+what+question+can+I+help+you+with%3F&user=iva&channel=15"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/external/breadcrumb", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/breadcrumb");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "code=204&key=29&value=Thanks%2C+what+question+can+I+help+you+with%3F&user=iva&channel=15");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/breadcrumb");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "code=204&key=29&value=Thanks%2C+what+question+can+I+help+you+with%3F&user=iva&channel=15", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/external/breadcrumb")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("code=204&key=29&value=Thanks%2C+what+question+can+I+help+you+with%3F&user=iva&channel=15")
      .asString();

	
	

external/article_feedback

POST

https://api.syn-finity.com/1.1/external/article_feedback

Example API Request

Resource information

Logs a feedback selection to the latest feedback log. This resource will replace the article_rate resource. Currently only to be used to log multi-choice feedback. Cannot be used for free text feedback.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • question

    string

    Required

    The question text of the chosen feedback

    Example Did this answer your question?

  • answer

    string

    Required

    The answer text of the chosen feedback

    Example Yes

  • token

    string

    Required

    This must be included in all valid calls to the search API. It includes session identification information to enable user activities to be tied together in a 'conversation' as well as validation information. A token must be generated for each unique user and will expire 2 hours after generation.

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

Example Request

{
  "question":"Did this answer your question?",
  "answer":"Yes",
  "token":"97B25C61-19FF-XXXX-3824-CAA8D691B010"
}

Example Response

[
  
]

Expected Errors

  • Error Code

    Summary

  • 185

    LOGGING FAILURE

HTTP Example

	
    POST /1.1/external/article_feedback HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    question=Did+this+answer+your+question%3F&answer=Yes&token=97B25C61-19FF-XXXX-3824-CAA8D691B010
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/external/article_feedback?question=Did+this+answer+your+question%3F&answer=Yes&token=97B25C61-19FF-XXXX-3824-CAA8D691B010"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/article_feedback?question=Did+this+answer+your+question%3F&answer=Yes&token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/external/article_feedback",
        dataType:"json",
        crossDomain:true,
        data:"question=Did+this+answer+your+question%3F&answer=Yes&token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "question=Did+this+answer+your+question%3F&answer=Yes&token=97B25C61-19FF-XXXX-3824-CAA8D691B010"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/external/article_feedback", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/article_feedback");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "question=Did+this+answer+your+question%3F&answer=Yes&token=97B25C61-19FF-XXXX-3824-CAA8D691B010");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/article_feedback");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "question=Did+this+answer+your+question%3F&answer=Yes&token=97B25C61-19FF-XXXX-3824-CAA8D691B010", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/external/article_feedback")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("question=Did+this+answer+your+question%3F&answer=Yes&token=97B25C61-19FF-XXXX-3824-CAA8D691B010")
      .asString();

	
	

external/article_rate

POST

https://api.syn-finity.com/1.1/external/article_rate

Example API Request

Resource information

Allows end users to rate the quality of the article either using a rating of between 1 and 5 plus textual feedback OR giving answers as per the feedback questions and answers returned in the article resource.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • Q1

    string

    Optional

    The answer for the question. Either one of the options set in the feedback answers returned as part of the article resource or textual feedback

    Example Yes

  • Q2

    string

    Optional

    The answer for the question. Either one of the options set in the feedback answers returned as part of the article resource or textual feedback

    Example Yes

  • Q3

    string

    Optional

    The answer for the question. Either one of the options set in the feedback answers returned as part of the article resource or textual feedback

    Example Yes

  • Q4

    string

    Optional

    The answer for the question. Either one of the options set in the feedback answers returned as part of the article resource or textual feedback

    Example Yes

  • rating

    integer

    Optional

    Rating of the article if a 1-5 rating is being used.

    Example 4

  • feedback

    string

    Optional

    Textual feedback for the rating

    Example Answred my question perfectly

  • answerid

    integer

    Required

    The answer ID as returned as part of the returned value from the external/article call. This allows user / FAQ and rating to be tied together for logging purposes.

    Example 123456789

  • token

    string

    Required

    This must be included in all valid calls to the search API. It includes session identification information to enable user activities to be tied together in a 'conversation' as well as validation information. A token must be generated for each unique user and will expire 2 hours after generation.

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

Example Request

{
  "rating":3,
  "answerid":"123456789",
  "token":"97B25C61-19FF-XXXX-3824-CAA8D691B010"
}

Example Response

[
  
]

Expected Errors

  • Error Code

    Summary

  • 106

    MISSING PARAMETER

  • 117

    DATA NOT VALID

  • 112

    TOKEN DOES NOT CONTAIN VALID SIGNATURE

  • 113

    TOKEN EXPIRED

  • 114

    INVALID TOKEN

  • 115

    INVALID IP

  • 157

    NO RESULTS

HTTP Example

	
    POST /1.1/external/article_rate HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    Q1=Yes&Q2=Yes&Q3=Yes&Q4=Yes&rating=4&feedback=Answred+my+question+perfectly&answerid=123456789&token=97B25C61-19FF-XXXX-3824-CAA8D691B010
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/external/article_rate?Q1=Yes&Q2=Yes&Q3=Yes&Q4=Yes&rating=4&feedback=Answred+my+question+perfectly&answerid=123456789&token=97B25C61-19FF-XXXX-3824-CAA8D691B010"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/article_rate?Q1=Yes&Q2=Yes&Q3=Yes&Q4=Yes&rating=4&feedback=Answred+my+question+perfectly&answerid=123456789&token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/external/article_rate",
        dataType:"json",
        crossDomain:true,
        data:"Q1=Yes&Q2=Yes&Q3=Yes&Q4=Yes&rating=4&feedback=Answred+my+question+perfectly&answerid=123456789&token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "Q1=Yes&Q2=Yes&Q3=Yes&Q4=Yes&rating=4&feedback=Answred+my+question+perfectly&answerid=123456789&token=97B25C61-19FF-XXXX-3824-CAA8D691B010"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/external/article_rate", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/article_rate");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "Q1=Yes&Q2=Yes&Q3=Yes&Q4=Yes&rating=4&feedback=Answred+my+question+perfectly&answerid=123456789&token=97B25C61-19FF-XXXX-3824-CAA8D691B010");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/article_rate");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "Q1=Yes&Q2=Yes&Q3=Yes&Q4=Yes&rating=4&feedback=Answred+my+question+perfectly&answerid=123456789&token=97B25C61-19FF-XXXX-3824-CAA8D691B010", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/external/article_rate")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("Q1=Yes&Q2=Yes&Q3=Yes&Q4=Yes&rating=4&feedback=Answred+my+question+perfectly&answerid=123456789&token=97B25C61-19FF-XXXX-3824-CAA8D691B010")
      .asString();

	
	

external/categories

GET, POST

https://api.syn-finity.com/1.1/external/categories

Example API Request

Resource information

Returns the categories and subcategories associated with a particular knowledge base.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • views

    boolean

    Optional

    If you wish to confine your list of categories to those applicable ONLY to the current view, set this parameter to true. Otherwise, it defaults to false and will return categories for all views allowed.

    Example 1

Example Request

[
  
]

Example Response

[
  {
    "category":"Answers",
    "subcategory":[
      "Answer guidelines",
      "Answer formats"
    ]
  },
  {
    "category":"Boxes N Stuff",
    "subcategory":[
      "Corporate"
    ]
  },
  {
    "category":"Editor",
    "subcategory":[
      "Editing"
    ]
  },
  {
    "category":"Examples",
    "subcategory":[
      "Bad Answers",
      "Good Answers",
      "Good FAQs",
      "Bad FAQs"
    ]
  },
  {
    "category":"Questions",
    "subcategory":[
      "Question guidelines"
    ]
  },
  {
    "category":"Views",
    "subcategory":[
      "Alternate Views",
      "Advertisements",
      "Analytics"
    ]
  }
]

Expected Errors

  • Error Code

    Summary

HTTP Example

	
    GET, POST /1.1/external/categories HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    views=1
	
	

CURL Example

	
    curl --request GET, POST
    --url "https://api.syn-finity.com/1.1/external/categories?views=1"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/categories?views=1",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET, POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET, POST",
        url:"https://api.syn-finity.com/1.1/external/categories",
        dataType:"json",
        crossDomain:true,
        data:"views=1",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "views=1"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET, POST", "/1.1/external/categories", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET, POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/categories");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "views=1");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/categories");
    var request = new RestRequest(Method.GET, POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "views=1", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET, POST("https://api.syn-finity.com/1.1/external/categories")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("views=1")
      .asString();

	
	

external/report

POST

https://api.syn-finity.com/1.1/external/report

Example API Request

Resource information

Allows end users to report either search queries that return no result or articles that do not for some reason answer their question. If reporting a search query, the query string and textual feedback are required in addition to the user ID. If reporting an article, the label of the article, textual feedback and the type of issue. We would recommend 'The article is out of date', 'The article has mistakes', 'The article needs more information', 'The article has dead link(s)' and 'Other'.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • userID

    string

    Optional

    The ID of the end user (operator / customer)

    Example 123456

  • search

    string

    Optional

    The search query being reported

    Example close account

  • article

    string

    Optional

    The label of the article being reported

    Example qed00035

  • feedback

    string

    Optional

    The textual feedback being reported

    Example This answer needs more up to date information.

  • type

    string

    Optional

    The type of issue being reported with an article

    Example The article has mistakes

Example Request

{
  "userID":123456,
  "search":"cancel order",
  "feedback":"I couldn't find any appropriate articles for this. Can customers cancel orders?"
}

Example Response

{
  "reported":true
}

Expected Errors

  • Error Code

    Summary

  • 106

    MISSING PARAMETER

  • 124

    FAILED TO CONNECT

  • 169

    INCOMPATIBLE PARAMETERS

HTTP Example

	
    POST /1.1/external/report HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    userID=123456&search=close+account&article=qed00035&feedback=This+answer+needs+more+up+to+date+information.&type=The+article+has+mistakes
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/external/report?userID=123456&search=close+account&article=qed00035&feedback=This+answer+needs+more+up+to+date+information.&type=The+article+has+mistakes"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/report?userID=123456&search=close+account&article=qed00035&feedback=This+answer+needs+more+up+to+date+information.&type=The+article+has+mistakes",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/external/report",
        dataType:"json",
        crossDomain:true,
        data:"userID=123456&search=close+account&article=qed00035&feedback=This+answer+needs+more+up+to+date+information.&type=The+article+has+mistakes",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "userID=123456&search=close+account&article=qed00035&feedback=This+answer+needs+more+up+to+date+information.&type=The+article+has+mistakes"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/external/report", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/report");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "userID=123456&search=close+account&article=qed00035&feedback=This+answer+needs+more+up+to+date+information.&type=The+article+has+mistakes");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/report");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "userID=123456&search=close+account&article=qed00035&feedback=This+answer+needs+more+up+to+date+information.&type=The+article+has+mistakes", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/external/report")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("userID=123456&search=close+account&article=qed00035&feedback=This+answer+needs+more+up+to+date+information.&type=The+article+has+mistakes")
      .asString();

	
	

external/search

POST

https://api.syn-finity.com/1.1/external/search

Example API Request

Resource information

Returns a series of FAQs with associated labels, view(s) and category/subcategories, in response to the specific query string posted. The 'view' is bound into the API key provided and will be automatically used to filter/refine all searches carried out with the resource. You will have an opportunity to choose which view associated with this agent you wish the application to be bound to on creation of the application.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • query

    string

    Required

    The query being searched against

    Example hosted

  • userid

    string

    Required

    The name or ID you choose to use to identify users. If anonymous, a randomly generated number or string will work. This serves to tie user activity together in conversations.

    Example 47583920957393

  • token

    string

    Required

    This must be included in all valid calls to the search API. It includes session identification information to enable user activities to be tied together in a 'conversation' as well as validation information. A token must be generated for each unique user and will expire 2 hours after generation.

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • autosuggest

    boolean

    Optional

    If this call is from an autosuggest function the search needs to be done every keystroke. Accordingly, calls flagged as autosuggest will NOT log. Default is false unless stated otherwise.

    Example 1

  • count

    integer

    Optional

    The number of results per page.

    Example 10

  • category

    string

    Optional

    Category to restrict / filter search results by

    Example Boxes n Stuff

  • index

    integer

    Optional

    Numerical index of which result to start from (default 0).

    Example 0

Example Request

{
  "query":"boxes",
  "view":"FA",
  "count":10,
  "index":0,
  "userid":"47583920957393",
  "token":"97B25C61-19FF-XXXX-3824-CAA8D691B010"
}

Example Response

{
  "results":[
    {
      "index":0,
      "label":"d9",
      "faq":"Can I have a red box?",
      "view":"train1",
      "recommended":true,
      "taxonomy":{
        "category":[
          "Examples",
          "Bad FAQs"
        ]
      }
    },
    {
      "index":1,
      "label":"d18",
      "faq":"My boxes are wrong",
      "view":"train1",
      "recommended":false,
      "taxonomy":{
        "category":[
          "Examples",
          "Good FAQs"
        ]
      }
    },
    {
      "index":2,
      "label":"f1",
      "faq":"Can I have a box like my brothers",
      "view":"train1",
      "recommended":false,
      "taxonomy":{
        "category":[
          "Examples",
          "Bad Answers"
        ]
      }
    },
    {
      "index":3,
      "label":"d16",
      "faq":"I would like to return my boxes",
      "view":"train1",
      "recommended":false,
      "taxonomy":{
        "category":[
          "Examples",
          "Good FAQs"
        ]
      }
    },
    {
      "index":4,
      "label":"d7",
      "faq":"How can I order a box?",
      "view":"train1",
      "recommended":false,
      "taxonomy":{
        "category":[
          "Examples",
          "Good FAQs"
        ]
      }
    },
    {
      "index":5,
      "label":"f2",
      "faq":"Can I order a box online?",
      "view":"train1",
      "recommended":false,
      "taxonomy":{
        "category":[
          "Examples",
          "Bad Answers"
        ]
      }
    },
    {
      "index":6,
      "label":"d15",
      "faq":"The boxes I bought are not as expected",
      "view":"train1",
      "recommended":false,
      "taxonomy":{
        "category":[
          "Examples",
          "Good FAQs"
        ]
      }
    },
    {
      "index":7,
      "label":"d2",
      "faq":"What kinds of boxes do you sell?",
      "view":"train1",
      "recommended":false,
      "taxonomy":{
        "category":[
          "Examples",
          "Good FAQs"
        ]
      }
    },
    {
      "index":8,
      "label":"a1",
      "faq":"Who are Boxes N Stuff?",
      "view":"train1",
      "recommended":false,
      "taxonomy":{
        "category":[
          "Boxes N Stuff",
          "Corporate"
        ]
      }
    },
    {
      "index":9,
      "label":"d4",
      "faq":"Which of your glass boxes is the biggest?",
      "view":"train1",
      "recommended":false,
      "taxonomy":{
        "category":[
          "Examples",
          "Good FAQs"
        ]
      }
    }
  ],
  "totalresults":17
}

Expected Errors

  • Error Code

    Summary

  • 305

    NO KNOWLEDGE DATA

  • 306

    NO KNOWLEDGE DATA

  • 106

    MISSING PARAMETER

  • 112

    TOKEN DOES NOT CONTAIN VALID SIGNATURE

  • 113

    TOKEN EXPIRED

  • 114

    INVALID TOKEN

  • 115

    INVALID IP

HTTP Example

	
    POST /1.1/external/search HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    query=hosted&userid=47583920957393&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&autosuggest=1&count=10&category=Boxes+n+Stuff&index=0
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/external/search?query=hosted&userid=47583920957393&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&autosuggest=1&count=10&category=Boxes+n+Stuff&index=0"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/search?query=hosted&userid=47583920957393&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&autosuggest=1&count=10&category=Boxes+n+Stuff&index=0",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/external/search",
        dataType:"json",
        crossDomain:true,
        data:"query=hosted&userid=47583920957393&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&autosuggest=1&count=10&category=Boxes+n+Stuff&index=0",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "query=hosted&userid=47583920957393&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&autosuggest=1&count=10&category=Boxes+n+Stuff&index=0"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/external/search", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/search");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "query=hosted&userid=47583920957393&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&autosuggest=1&count=10&category=Boxes+n+Stuff&index=0");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/search");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "query=hosted&userid=47583920957393&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&autosuggest=1&count=10&category=Boxes+n+Stuff&index=0", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/external/search")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("query=hosted&userid=47583920957393&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&autosuggest=1&count=10&category=Boxes+n+Stuff&index=0")
      .asString();

	
	

external/session

POST

https://api.syn-finity.com/1.1/external/session

Example API Request

Resource information

Used in conjunction with other faqtagent resources to initate a session. The token generated is a required parameter for the external/search, external/article and external/article_rate resources.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

Example Request

[
  
]

Example Response

{
  "token":"97B25C61-19FF-XXXX-3824-CAA8D691B010"
}

Expected Errors

  • Error Code

    Summary

  • 106

    MISSING PARAMETER

HTTP Example

	
    POST /1.1/external/session HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/external/session?"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/session?",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/external/session",
        dataType:"json",
        crossDomain:true,
        data:"",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = ""

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/external/session", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/session");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/session");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/external/session")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("")
      .asString();

	
	

external/session

GET

https://api.syn-finity.com/1.1/external/session

Example API Request

Resource information

Can be used to check that a session is still valid at the start of a new session. Returns information about the validity of the current token. A new token can be generated should the session be found to be invalid or expired.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • token

    string

    Required

    This must be included in all valid calls to the search API. It includes session identification information to enable user activities to be tied together in a 'conversation' as well as validation information. A token must be generated for each unique user and will expire 2 hours after generation.

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

Example Request

{
  "token":"97B25C61-19FF-XXXX-3824-CAA8D691B010"
}

Example Response

{
  "ValidToken":true,
  "Expired":false,
  "ValidApplication":true,
  "IP":true,
  "view":"Training"
}

Expected Errors

  • Error Code

    Summary

  • 106

    MISSING PARAMETER

HTTP Example

	
    GET /1.1/external/session HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    token=97B25C61-19FF-XXXX-3824-CAA8D691B010
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/external/session?token=97B25C61-19FF-XXXX-3824-CAA8D691B010"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/session?token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/external/session",
        dataType:"json",
        crossDomain:true,
        data:"token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "token=97B25C61-19FF-XXXX-3824-CAA8D691B010"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/external/session", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/session");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "token=97B25C61-19FF-XXXX-3824-CAA8D691B010");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/session");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "token=97B25C61-19FF-XXXX-3824-CAA8D691B010", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/external/session")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("token=97B25C61-19FF-XXXX-3824-CAA8D691B010")
      .asString();

	
	

external/session

DELETE

https://api.syn-finity.com/1.1/external/session

Example API Request

Resource information

Can be used to destroy an existing session. Once this is called the session can no longer be used.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • token

    string

    Required

    This must be included in all valid calls to the search API. It includes session identification information to enable user activities to be tied together in a 'conversation' as well as validation information. A token must be generated for each unique user and will expire 2 hours after generation.

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

Example Request

{
  "token":"97B25C61-19FF-XXXX-3824-CAA8D691B010"
}

Example Response

{
  "Destroyed":true
}

Expected Errors

  • Error Code

    Summary

  • 106

    MISSING PARAMETER

HTTP Example

	
    DELETE /1.1/external/session HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    token=97B25C61-19FF-XXXX-3824-CAA8D691B010
	
	

CURL Example

	
    curl --request DELETE
    --url "https://api.syn-finity.com/1.1/external/session?token=97B25C61-19FF-XXXX-3824-CAA8D691B010"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/session?token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "DELETE",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"DELETE",
        url:"https://api.syn-finity.com/1.1/external/session",
        dataType:"json",
        crossDomain:true,
        data:"token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "token=97B25C61-19FF-XXXX-3824-CAA8D691B010"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("DELETE", "/1.1/external/session", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/session");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "token=97B25C61-19FF-XXXX-3824-CAA8D691B010");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/session");
    var request = new RestRequest(Method.DELETE);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "token=97B25C61-19FF-XXXX-3824-CAA8D691B010", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.DELETE("https://api.syn-finity.com/1.1/external/session")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("token=97B25C61-19FF-XXXX-3824-CAA8D691B010")
      .asString();

	
	

external/session

PATCH

https://api.syn-finity.com/1.1/external/session

Example API Request

Resource information

Alter the current session

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • token

    string

    Required

    This must be included in all valid calls to the search API. It includes session identification information to enable user activities to be tied together in a 'conversation' as well as validation information. A token must be generated for each unique user and will expire 2 hours after generation.

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • view

    string

    Optional

    The name of the view which you wish to change to

    Example Archive

Example Request

{
  "token":"97B25C61-19FF-XXXX-3824-CAA8D691B010",
  "view":"Archive"
}

Example Response

{
  "updated":true
}

Expected Errors

  • Error Code

    Summary

  • 106

    MISSING PARAMETER

HTTP Example

	
    PATCH /1.1/external/session HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    token=97B25C61-19FF-XXXX-3824-CAA8D691B010&view=Archive
	
	

CURL Example

	
    curl --request PATCH
    --url "https://api.syn-finity.com/1.1/external/session?token=97B25C61-19FF-XXXX-3824-CAA8D691B010&view=Archive"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/session?token=97B25C61-19FF-XXXX-3824-CAA8D691B010&view=Archive",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "PATCH",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"PATCH",
        url:"https://api.syn-finity.com/1.1/external/session",
        dataType:"json",
        crossDomain:true,
        data:"token=97B25C61-19FF-XXXX-3824-CAA8D691B010&view=Archive",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "token=97B25C61-19FF-XXXX-3824-CAA8D691B010&view=Archive"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("PATCH", "/1.1/external/session", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/session");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "token=97B25C61-19FF-XXXX-3824-CAA8D691B010&view=Archive");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/session");
    var request = new RestRequest(Method.PATCH);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "token=97B25C61-19FF-XXXX-3824-CAA8D691B010&view=Archive", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.PATCH("https://api.syn-finity.com/1.1/external/session")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("token=97B25C61-19FF-XXXX-3824-CAA8D691B010&view=Archive")
      .asString();

	
	

external/self_configure

GET

https://api.syn-finity.com/1.1/external/self_configure

Example API Request

Resource information

Returns the current configuration settings for products of a particular application.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

Example Request

[
  
]

Example Response

{
  "start_mode":"",
  "sxlocation":"\/\/synthetix.syn-finity.com\/",
  "height":"auto",
  "width":"auto",
  "intro_mode":"faq",
  "fa_contact_always":true,
  "fa_contact":"http:\/\/www.synthetix.com",
  "fa_chat_trigg":false,
  "fa_chat_trigg_name":"",
  "tr_fb":false,
  "fa_print":true,
  "show_cats":true,
  "cat_img":false,
  "showsubcats":false,
  "fb_contact":true,
  "fb_lc":false,
  "fb_log":{
    "Q1":{
      "Yes":{
        "action":"quit",
        "contact":false
      },
      "No":{
        "action":"quit",
        "contact":false,
        "max":3,
        "onmax":{
          "zork":"N51"
        }
      }
    }
  },
  "fb_lc_trigg":"",
  "rel_q":true,
  "rel_q_resultno":3,
  "resultno":6,
  "faqno":6,
  "sch_numbers":true,
  "autofit":true,
  "one_sec_sch":true,
  "show_ctrl_st":false,
  "lc_email":"",
  "lc_times":false,
  "queuepos":false,
  "lc_agent_avatar":false,
  "lc_telephone":false,
  "lc_attachments":false,
  "lc_confidential":false,
  "lc_reference":false,
  "lc_email_mand":false,
  "lc_telephone_mand":false,
  "lc_reference_mand":false,
  "lc_emo":false,
  "lc_firstmess":false,
  "lc_transcript_choice":false,
  "banners":false,
  "answerwidth":"0",
  "lc_fb_a_format":[
    ""
  ],
  "environment":"dev",
  "css_path":[
    "sx_animate.min.css",
    "sx_func.css",
    "sx_triggers.css",
    "sx_icons.css",
    "sx_pres.css"
  ],
  "iva":true,
  "zork_id":44,
  "recommended_top":[
    "I think I've found what you're looking for.",
    "I hope this is helpful.",
    "I think this might help."
  ],
  "recommended_tail":[
    "Did that answer your question?",
    "Does that help?",
    "Please let me know if that didn't answer your question",
    "Was that helpful?"
  ],
  "single_top":[
    "I think this might help.",
    "I've found something that might answer your question.",
    "I think this might assist you."
  ],
  "single_tail":[
    "If that didn't answer your enquiry, please try rewording your question.",
    "Does that help? If not, please try to rephrase your question.",
    "Was that helpful? If not, please try rewording your question.",
    "I hope that was useful. If not, please try rewording your question."
  ],
  "multi_top":[
    "Do any of these help? Just click on one of the options below to see.",
    "Did you mean ...",
    "Please click on one of these if it looks like it would help.",
    "I'm trying to help, but I'm not sure I fully understand the question. Do any of these help?"
  ],
  "multi_tail":[
    "If that didn't answer your enquiry, please try rewording your question.",
    "Does that help? If not, please try to rephrase your question.",
    "Was that helpful? If not, please try rewording your question.",
    "I hope that was useful. If not, please try rewording your question."
  ],
  "skip_mess":"No problem.",
  "iva_transcript":false,
  "extra_wordage":{
    "back_to_faq":"Back to FAQs",
    "char_no":"Remaining characters 512",
    "confidential_label":"Confidential message",
    "email_reminder":"Please provide your email address if you would like to receive a transcript of your chat:",
    "fa_trigg_wordage":"Ask Lisa",
    "leave_chat_alert":"Are you sure you want to leave this chat?",
    "leave_chat_alert_n":"No",
    "leave_chat_alert_y":"Yes",
    "request_transcript":"Request transcript",
    "transcript_choice":"Tick here if you would like to receive a transcript of your chat."
  },
  "iva_name":"Lisa",
  "webhooks":{
    "sx_iva_article":26,
    "sx_iva_dialogue":25,
    "send_feedback":27,
    "patch_session":28
  },
  "return_tol":60,
  "ints_between_retry":4,
  "disclaimer_url":"",
  "privacy_url":"http:\/\/www.synthetix.com\/privacy\/",
  "channel":15,
  "close_button_enabled":false,
  "popout_button_enabled":false,
  "cookies_disabled_check":true,
  "popup_button_enabled":false,
  "end_button":false,
  "lc_english":{
    "cancel_option":"Cancel",
    "cancelandreturntofaq":"Cancel and return to FAQs",
    "char_count_text":"characters remaining.",
    "chat_complete_1":"Your chat with ",
    "chat_complete_2":" is now complete.",
    "chat_guidance_with_kb":"You are no longer in a live web chat, but may browse this knowledge-base article.",
    "chat_guidance_with_kb_lc":"You are still in a live chat. Click the 'X' icon or close button to return to your chat when ready.",
    "chattingwith":"You are chatting with",
    "complete_chat_close_window":"Your chat has finished - you may now close this window.",
    "complete_chat_head":"Your chat is complete.",
    "complete_chat_text":"Thank you for chatting with us today. Please take the time to let us know what you thought of your chat with",
    "email_alert":"Please supply your email address before continuing.",
    "email_field":"Your email address *",
    "end_chat_button":"End chat",
    "feedback_guidance_alert":"Please select an item from the dropdown list.",
    "feedback_option_default":"-- Please Select --",
    "feedback_text_placeholder":"Type your feedback here...",
    "first_name_alert":"Please supply your first name before continuing.",
    "form_smallprint":"Please note all chats will be recorded or monitored for quality and training purposes.",
    "full_name_alert":"Please supply your full name before continuing.",
    "istyping":" is typing ...",
    "kb_close_but_text":"Close",
    "kb_unavailable_head":"Live Chat Unavailable",
    "kb_unavailable_text":"Sorry, none of our customer care team are currently available to chat right now.Please come back and try again later.",
    "last_name_alert":"Please supply your last name before continuing.",
    "lc_placeholder_text":"Type here...",
    "name_field":"Your full name *",
    "nearly_there":"The chat session will commence shortly.",
    "operator_busy_message_button":"Close",
    "operator_busy_message_head":"Live Chat Unavailable",
    "operator_busy_message_text":"Sorry, none of our customer care team are currently available to chat right now.Please come back and try again later.",
    "select_default":"-- Select --",
    "send_button":"Send",
    "skill_select":"Select a topic for your chat *",
    "start_chat_wording":"Start live chat",
    "start_collect_head":"We're about to connect you...",
    "start_collect_text":"Our Customer care team is now available to chat. We just need to collect a few of your details:",
    "submit_feedback_button":"Submit feedback",
    "telephone_alert":"Please supply your telephone number before continuing.",
    "telephone_field":"Your telephone number *",
    "topic_alert":"Please select a topic before continuing.",
    "transcript_customer_name":"You",
    "unavailable_message_button":"Close",
    "unavailable_message_head":"Live Chat Unavailable",
    "unavailable_message_text":"Sorry, none of our customer care team are currently available to chat right now.

Please come back and try again later.", "url_field_text":"Click here for more", "waitmessage":"Please wait... checking for available live chat agents." }, "fa_english":{ "all_cat_name":"All categories", "allfaqs_head":"Frequently asked questions:", "allfaqs_text":"Here are all of our FAQs:", "allfaqscat_head":"Frequently asked questions:", "allfaqscat_text":"Here are all of our FAQs in the '&popcatval' category:", "answer_heading":"YOUR SELECTED QUESTION:", "answerheading_html":"", "back_html":"Back", "cat_menu_header_text":"Categories", "contact_url":"", "contactinfo_chat_html":"LiveChat", "contactinfo_html":"Contact us", "forward_html":"Next", "in_total":"in total", "istillneedhelp_html":"Still need help?", "lc_promo_text":"Click here for
Live Chat:", "linktext":"Click here for further information:", "multipleresulttext_html":"Choose from &result_count results below. The best match will appear first:", "multipleresulttextsub_html":"Choose from &cc_result_show results below in '&master_category'. The best match will appear first:", "myquestionisnotlisted_html":"", "no_cat_info":"There is no information to show here, yet.", "no_related_qs":"There are no related FAQs available at present.", "overallpopularquestions_html":"Frequently asked questions:", "overallrelatedquestions_html":"Frequently asked questions:", "placeholder_text":"Ask a question ...", "popularfaqs_html":"Frequently asked questions:", "popularfaqscat_html":"Frequently asked '&popcatval' questions:", "print_answer_intro":"You asked the following question:", "printthisanswer_html":"Print answer", "rate_text_off_html":"Thank you for your feedback.", "refine_results":"Refine results", "relatedquestions_html":"Frequently asked questions:", "searchresults_html":"Your search results:", "singleresulttext_html":"One match has been found, shown below:", "singleresulttextsub_html":"One match has been found in '&master_category', shown below:", "updatedfaqs_head":"New and updated questions:", "updatedfaqs_text":"Here are the newest answers we've added to the knowledge-base:", "url_field_text":"Click here for more", "zeroresults_head":"No results found:", "zeroresults_text":"We can't find an answer to your question, but here are some of the most popular FAQs:" } }

Expected Errors

  • Error Code

    Summary

HTTP Example

	
    GET /1.1/external/self_configure HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/external/self_configure?"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/self_configure?",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/external/self_configure",
        dataType:"json",
        crossDomain:true,
        data:"",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = ""

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/external/self_configure", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/self_configure");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/self_configure");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/external/self_configure")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("")
      .asString();

	
	

external/session_check

POST

https://api.syn-finity.com/1.1/external/session_check

Example API Request

Resource information

DEPRECATED in favour of /session. Can be used to check that a session is still valid at the start of a new session. Returns information about the validity of the current token. A new token can be generated should the session be found to be invalid or expired.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • token

    string

    Required

    This must be included in all valid calls to the search API. It includes session identification information to enable user activities to be tied together in a 'conversation' as well as validation information. A token must be generated for each unique user and will expire 2 hours after generation.

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

Example Request

{
  "token":"97B25C61-19FF-XXXX-3824-CAA8D691B010"
}

Example Response

{
  "ValidToken":true,
  "Expired":false,
  "ValidApplication":true,
  "IP":true
}

Expected Errors

  • Error Code

    Summary

  • 106

    MISSING PARAMETER

HTTP Example

	
    POST /1.1/external/session_check HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    token=97B25C61-19FF-XXXX-3824-CAA8D691B010
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/external/session_check?token=97B25C61-19FF-XXXX-3824-CAA8D691B010"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/session_check?token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/external/session_check",
        dataType:"json",
        crossDomain:true,
        data:"token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "token=97B25C61-19FF-XXXX-3824-CAA8D691B010"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/external/session_check", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/session_check");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "token=97B25C61-19FF-XXXX-3824-CAA8D691B010");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/session_check");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "token=97B25C61-19FF-XXXX-3824-CAA8D691B010", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/external/session_check")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("token=97B25C61-19FF-XXXX-3824-CAA8D691B010")
      .asString();

	
	

external/session_initation

GET

https://api.syn-finity.com/1.1/external/session_initation

Example API Request

Resource information

DEPRECATED in favour of /session. Used in conjunction with other faqtagent resources to initate a session. The token generated is a required parameter for the external/search, external/article and external/article_rate resources.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

Example Request

[
  
]

Example Response

{
  "token":"97B25C61-19FF-XXXX-3824-CAA8D691B010"
}

Expected Errors

  • Error Code

    Summary

  • 106

    MISSING PARAMETER

HTTP Example

	
    GET /1.1/external/session_initation HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/external/session_initation?"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/session_initation?",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/external/session_initation",
        dataType:"json",
        crossDomain:true,
        data:"",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = ""

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/external/session_initation", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/session_initation");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/session_initation");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/external/session_initation")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("")
      .asString();

	
	

external/session_trail

POST

https://api.syn-finity.com/1.1/external/session_trail

Example API Request

Resource information

Returns the labels and questions of FAQs that have been clicked on by the user in their current session.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • token

    string

    Required

    This must be included in all valid calls to the search API. It includes session identification information to enable user activities to be tied together in a 'conversation' as well as validation information. A token must be generated for each unique user and will expire 2 hours after generation.

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

Example Request

[
  
]

Example Response

[
  
]

Expected Errors

  • Error Code

    Summary

  • 106

    MISSING PARAMETER

HTTP Example

	
    POST /1.1/external/session_trail HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    token=97B25C61-19FF-XXXX-3824-CAA8D691B010
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/external/session_trail?token=97B25C61-19FF-XXXX-3824-CAA8D691B010"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/session_trail?token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/external/session_trail",
        dataType:"json",
        crossDomain:true,
        data:"token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "token=97B25C61-19FF-XXXX-3824-CAA8D691B010"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/external/session_trail", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/session_trail");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "token=97B25C61-19FF-XXXX-3824-CAA8D691B010");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/session_trail");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "token=97B25C61-19FF-XXXX-3824-CAA8D691B010", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/external/session_trail")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("token=97B25C61-19FF-XXXX-3824-CAA8D691B010")
      .asString();

	
	

external/trigger

GET

https://api.syn-finity.com/1.1/external/trigger

Example API Request

Resource information

Checks for triggers against the calling page or a particular trigger name. Returns details of trigger, associated skills, launch type, availability.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • name

    string

    Optional

    The name of the trigger being checked

    Example home_page

  • type

    string

    Optional

    Channel name or number

    Example live chat

  • url

    string

    Optional

    The name of the firing page (the page the trigger is on.

    Example http://trumpdonald.org

Example Request

[
  
]

Example Response

{
  "triggers":{
    "TriggerMcTriggerFace":{
      "availableskillset":[
        "Boxing boxes",
        "Closing boxes",
        "Boxing boxes",
        "Test",
        "Boxing boxes",
        "Opening boxes",
        "Closing boxes",
        "Test"
      ],
      "destinationStyle":"Page Change",
      "effect":"sx_fadeIn",
      "height":"350",
      "hideDelay":"40",
      "online":true,
      "onlineDestination":"",
      "onlineDestinationMobile":"",
      "onlineImage":"",
      "position":"Screen Center",
      "showDelay":"10",
      "target":"",
      "triggerSkillset":[
        "Boxing boxes",
        "Opening boxes",
        "Closing boxes",
        "Test"
      ],
      "triggerStyle":"popup",
      "type":"Live chat",
      "width":"266"
    }
  },
  "triggersavailable":1
}

Expected Errors

  • Error Code

    Summary

HTTP Example

	
    GET /1.1/external/trigger HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    name=home_page&type=live+chat&url=http%3A%2F%2Ftrumpdonald.org
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/external/trigger?name=home_page&type=live+chat&url=http%3A%2F%2Ftrumpdonald.org"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/trigger?name=home_page&type=live+chat&url=http%3A%2F%2Ftrumpdonald.org",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/external/trigger",
        dataType:"json",
        crossDomain:true,
        data:"name=home_page&type=live+chat&url=http%3A%2F%2Ftrumpdonald.org",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "name=home_page&type=live+chat&url=http%3A%2F%2Ftrumpdonald.org"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/external/trigger", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/trigger");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "name=home_page&type=live+chat&url=http%3A%2F%2Ftrumpdonald.org");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/trigger");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "name=home_page&type=live+chat&url=http%3A%2F%2Ftrumpdonald.org", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/external/trigger")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("name=home_page&type=live+chat&url=http%3A%2F%2Ftrumpdonald.org")
      .asString();

	
	

external/trigger

PUT

https://api.syn-finity.com/1.1/external/trigger

Example API Request

Resource information

Records dismissals of a given trigger.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • name

    string

    Optional

    The name of the trigger being checked

    Example home_page

  • action

    string

    Required

    The type of action against a trigger

    Example dismiss

Example Request

[
  
]

Example Response

{
  "logged":true
}

Expected Errors

  • Error Code

    Summary

  • 177

    VOID TRIGGER ID

HTTP Example

	
    PUT /1.1/external/trigger HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    name=home_page&action=dismiss
	
	

CURL Example

	
    curl --request PUT
    --url "https://api.syn-finity.com/1.1/external/trigger?name=home_page&action=dismiss"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/trigger?name=home_page&action=dismiss",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "PUT",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"PUT",
        url:"https://api.syn-finity.com/1.1/external/trigger",
        dataType:"json",
        crossDomain:true,
        data:"name=home_page&action=dismiss",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "name=home_page&action=dismiss"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("PUT", "/1.1/external/trigger", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/trigger");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "name=home_page&action=dismiss");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/trigger");
    var request = new RestRequest(Method.PUT);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "name=home_page&action=dismiss", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.PUT("https://api.syn-finity.com/1.1/external/trigger")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("name=home_page&action=dismiss")
      .asString();

	
	

external/views

GET

https://api.syn-finity.com/1.1/external/views

Example API Request

Resource information

Returns the views associated with a particular knowledge base. Returns the views that the application is allowed to use and the current view. Please note that faqtAgent resources are locked to the view selected when the application is created. Searches will be restricted to that view. However, this will allow developers to be aware of other views that may be contained within the knowledge base for informational purposes and to allow, perhaps, the specific exclusion of other views from processes.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

Example Request

[
  
]

Example Response

[
  "train1",
  "train2",
  "train3",
  "Call Centre",
  "archive",
  "test"
]

Expected Errors

  • Error Code

    Summary

  • 124

    FAILED TO CONNECT

HTTP Example

	
    GET /1.1/external/views HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/external/views?"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/views?",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/external/views",
        dataType:"json",
        crossDomain:true,
        data:"",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = ""

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/external/views", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/views");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/views");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/external/views")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("")
      .asString();

	
	

external/webhook

GET

https://api.syn-finity.com/1.1/external/webhook

Example API Request

Resource information

Executes a webhook and returns the response from it.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • id

    string

    Required

    The id of the webhook

    Example 41

Example Request

{
  "id":41
}

Example Response

{
  "webhookResponse":[
    "{\"salutation\":\"Evening\",\"salutation_lower\":\"evening\",\"time\":{\"min\":\"00\",\"hour\":\"00\",\"concat\":\"00:00\"},\"meridiem\":\"AM\"}"
  ]
}

Expected Errors

  • Error Code

    Summary

HTTP Example

	
    GET /1.1/external/webhook HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    id=41
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/external/webhook?id=41"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/external/webhook?id=41",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/external/webhook",
        dataType:"json",
        crossDomain:true,
        data:"id=41",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "id=41"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/external/webhook", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/external/webhook");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "id=41");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/external/webhook");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "id=41", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/external/webhook")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("id=41")
      .asString();

	
	

forms/node

GET

https://api.syn-finity.com/1.1/forms/node

Example API Request

Resource information

Returns node information from an instance created in the Form Editor. Runs onload events, evaluates logic events and replaces variable placeholders with currently set values associated with the variable.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • form_id

    string

    Required

    The id of the instance. This can be found in the form settings within the Form Editor.

    Example 63

  • node_id

    string

    Optional

    The id of the node within the instance. This is the number after the 'N' found on each node in the Form Editor. If this is not included then the start node will be returned.

    Example 2

  • token

    string

    Required

    This must be included in all valid calls to the node API. It includes session identification information to enable user activities to be tied together in a 'conversation' as well as validation information. A token must be generated for each unique user and will expire 2 hours after generation.

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • lid

    string

    Optional

    The id of an element within the instance. This is the number after the 'E', which can be found by loading your instance in the Form Editor and opening the settings for that particular element.

    Example 5

Example Request

{
  "form_id":63,
  "node_id":2,
  "token":"97B25C61-19FF-XXXX-3824-CAA8D691B010",
  "lid":5
}

Example Response

{
  "settings":{
    "back_enabled":true,
    "show_start_time":"",
    "show_end_time":"",
    "view_id":"",
    "cookie_exp":"",
    "variables":[
      {
        "id":"V1",
        "name":"name",
        "order":"random",
        "values":[
          {
            "id":"R19",
            "value":"1",
            "order":1
          },
          {
            "id":"R20",
            "value":"2",
            "order":2
          },
          {
            "id":"R18",
            "value":"3",
            "order":3
          },
          {
            "id":"R16",
            "value":"4",
            "order":4
          }
        ]
      },
      {
        "id":"V2",
        "name":"logic_name",
        "order":"",
        "values":[
          
        ]
      }
    ],
    "form_type":"14",
    "exceptions":[
      "N1 has a clickable element with no route value",
      "N3 has a clickable element with no route value",
      "N4 has a clickable element with no route value",
      "N5 has a clickable element with no route value",
      "N12 has a clickable element with no route value",
      "N16 has a clickable element with no route value",
      "N18 has a clickable element with no route value"
    ]
  },
  "environmental":{
    "**ZORK**":{
      "thanks":{
        "values":[
          {
            "id":"R170",
            "value":"Thank you, that's great.",
            "order":2
          },
          {
            "id":"R171",
            "value":"Thank you very much.",
            "order":3
          },
          {
            "id":"R251",
            "value":"Great, thanks for that",
            "order":5
          }
        ],
        "order":"random"
      },
      "name":{
        "values":[
          {
            "id":"R20",
            "value":"2",
            "order":2
          },
          {
            "id":"R19",
            "value":"1",
            "order":1
          },
          {
            "id":"R18",
            "value":"3",
            "order":3
          },
          {
            "id":"R16",
            "value":"4",
            "order":4
          }
        ],
        "order":"random"
      },
      "pricerange":{
        "values":[
          {
            "id":"R38",
            "value":null,
            "order":1
          }
        ],
        "order":null
      },
      "retry":{
        "values":[
          {
            "id":"R187",
            "value":true,
            "order":1
          },
          {
            "id":"R188",
            "value":false,
            "order":2
          }
        ],
        "order":null
      }
    },
    "goal":"2",
    "key":"firstname",
    "name":"1",
    "placeholder":"Please type your name here",
    "value":"{{ENVIRONMENTAL.firstname}}"
  },
  "node":{
    "id":"N2",
    "parent":"start",
    "parent_path":"",
    "description":"Elements",
    "script":"",
    "settings":{
      "back_enabled":true,
      "direction":"vertical",
      "events":{
        "enabled":true,
        "rules":[
          {
            "id":"R10",
            "type":"session",
            "node":"",
            "order":1,
            "utterance":"",
            "callback":"",
            "trigger":"onload",
            "logic":{
              "operators":[
                
              ],
              "execution":"",
              "then":"",
              "else":""
            },
            "delay":0,
            "goals":[
              
            ],
            "parameters":{
              "name":"1"
            },
            "logging":{
              "code":"",
              "description":"",
              "details":""
            },
            "skip_to":{
              "node":"",
              "logging":true
            }
          },
          {
            "id":"R11",
            "type":"logic",
            "node":"",
            "order":2,
            "utterance":"",
            "callback":"",
            "trigger":"onload",
            "logic":{
              "operators":[
                {
                  "if":"name",
                  "comparator":"not_exist",
                  "than":"1"
                }
              ],
              "execution":"not_exist",
              "then":"restart",
              "else":"R14"
            },
            "delay":1,
            "goals":[
              
            ],
            "parameters":[
              
            ],
            "skip_to":{
              "node":"",
              "logging":true
            },
            "logging":{
              "code":"",
              "description":"",
              "details":""
            }
          },
          {
            "id":"R14",
            "type":"logic",
            "node":"",
            "order":5,
            "utterance":"",
            "callback":"console.log('hello')",
            "trigger":"else",
            "logic":{
              "operators":[
                {
                  "if":"1",
                  "comparator":"equal_to",
                  "than":"2"
                }
              ],
              "execution":"equal_to",
              "then":"restart",
              "else":"R15"
            },
            "delay":"",
            "goals":[
              
            ],
            "parameters":[
              
            ],
            "logging":{
              "code":"",
              "description":"",
              "details":""
            },
            "skip_to":{
              "node":"",
              "logging":true
            }
          },
          {
            "id":"R15",
            "type":"utterance",
            "node":"",
            "order":6,
            "utterance":"What?",
            "callback":"",
            "trigger":"else",
            "logic":{
              "operators":[
                
              ],
              "execution":"",
              "then":"",
              "else":""
            },
            "delay":5,
            "goals":[
              
            ],
            "parameters":[
              
            ],
            "logging":{
              "code":"",
              "description":"",
              "details":""
            },
            "skip_to":{
              "node":"",
              "logging":true
            }
          }
        ]
      },
      "faq_visibility":{
        "enabled":false,
        "category":"",
        "faq":""
      }
    },
    "elements":[
      {
        "id":"E14",
        "message":"I am an image",
        "type":"output_image",
        "order":11,
        "url":"http:\/\/synthetix.com\/api\/documentation\/assets\/img\/SYNAPPS_LOGO300.png",
        "size":1,
        "text_position":"below",
        "alignment":"center",
        "tooltip":{
          "enabled":false,
          "delay":"",
          "message":"",
          "position":""
        }
      },
      {
        "id":"E15",
        "message":"Next",
        "type":"button",
        "format":"button",
        "url_src":"",
        "size":1,
        "order":12,
        "tooltip":{
          "enabled":false,
          "delay":"",
          "message":""
        },
        "route":{
          "type":"link",
          "address":"N1",
          "callback":"",
          "parameters":[
            
          ],
          "logging":true
        },
        "variable":""
      },
      {
        "id":"E106",
        "message":"test",
        "type":"button",
        "format":"image",
        "url_src":"",
        "size":1,
        "order":13,
        "tooltip":{
          "enabled":false,
          "delay":"",
          "message":""
        },
        "route":{
          "type":"external",
          "address":"http:\/\/www.google.com",
          "callback":"",
          "parameters":[
            
          ]
        },
        "url":"http:\/\/synthetix.com\/api\/documentation\/assets\/img\/SYNAPPS_LOGO300.png",
        "text_position":"below"
      }
    ]
  },
  "callback":[
    
  ],
  "logic":{
    "R11":{
      "id":"R11",
      "type":"logic",
      "node":"",
      "order":2,
      "utterance":"",
      "callback":"",
      "trigger":"onload",
      "logic":{
        "execution":"not_exist",
        "then":"restart",
        "else":"R14"
      },
      "delay":1,
      "goals":[
        
      ],
      "parameters":[
        
      ],
      "skip_to":{
        "node":"",
        "logging":true
      },
      "logging":{
        "code":"",
        "description":"",
        "details":""
      },
      "operators":[
        {
          "if":"name",
          "comparator":"not_exist",
          "than":"1"
        }
      ],
      "result":false
    },
    "R14":{
      "id":"R14",
      "type":"logic",
      "node":"",
      "order":5,
      "utterance":"",
      "callback":"console.log('hello')",
      "trigger":"else",
      "logic":{
        "execution":"equal_to",
        "then":"restart",
        "else":"R15"
      },
      "delay":"",
      "goals":[
        
      ],
      "parameters":[
        
      ],
      "logging":{
        "code":"",
        "description":"",
        "details":""
      },
      "skip_to":{
        "node":"",
        "logging":true
      },
      "operators":[
        {
          "if":"1",
          "comparator":"equal_to",
          "than":"2"
        }
      ],
      "result":false
    }
  },
  "goals":[
    
  ],
  "utterances":[
    {
      "utterance":"What?",
      "trigger":"else"
    }
  ],
  "redirects":[
    
  ],
  "restart":false
}

Expected Errors

  • Error Code

    Summary

HTTP Example

	
    GET /1.1/forms/node HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    form_id=63&node_id=2&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&lid=5
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/forms/node?form_id=63&node_id=2&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&lid=5"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/forms/node?form_id=63&node_id=2&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&lid=5",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/forms/node",
        dataType:"json",
        crossDomain:true,
        data:"form_id=63&node_id=2&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&lid=5",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "form_id=63&node_id=2&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&lid=5"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/forms/node", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/forms/node");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "form_id=63&node_id=2&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&lid=5");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/forms/node");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "form_id=63&node_id=2&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&lid=5", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/forms/node")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("form_id=63&node_id=2&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&lid=5")
      .asString();

	
	

helper/product_status

GET

https://api.syn-finity.com/1.1/helper/product_status

Example API Request

Resource information

Get the current status of all Synthetix products and services

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

Example Request

[
  
]

Example Response

[
  {
    "name":"Web Self Service",
    "status":"Up",
    "rate":"300s",
    "uptime":{
      "Apr 09":100,
      "Apr 10":100,
      "Apr 11":100,
      "Apr 12":100,
      "Apr 13":100,
      "Apr 14":100,
      "Apr 15":100
    }
  },
  {
    "name":"Call Centres",
    "status":"Up",
    "rate":"300s",
    "uptime":{
      "Apr 09":100,
      "Apr 10":100,
      "Apr 11":100,
      "Apr 12":100,
      "Apr 13":100,
      "Apr 14":100,
      "Apr 15":91.95
    }
  },
  {
    "name":"Email",
    "status":"Up",
    "rate":"300s",
    "uptime":{
      "Apr 09":100,
      "Apr 10":100,
      "Apr 11":100,
      "Apr 12":100,
      "Apr 13":100,
      "Apr 14":100,
      "Apr 15":100
    }
  },
  {
    "name":"Knowledge Bases",
    "status":"Up",
    "rate":"300s",
    "uptime":{
      "Apr 09":100,
      "Apr 10":100,
      "Apr 11":100,
      "Apr 12":100,
      "Apr 13":100,
      "Apr 14":100,
      "Apr 15":100
    }
  },
  {
    "name":"Live Chat",
    "status":"Up",
    "rate":"300s",
    "uptime":{
      "Apr 09":100,
      "Apr 10":100,
      "Apr 11":100,
      "Apr 12":100,
      "Apr 13":100,
      "Apr 14":100,
      "Apr 15":100
    }
  },
  {
    "name":"Editor",
    "status":"Up",
    "rate":"300s",
    "uptime":{
      "Apr 09":100,
      "Apr 10":100,
      "Apr 11":100,
      "Apr 12":100,
      "Apr 13":100,
      "Apr 14":100,
      "Apr 15":100
    }
  },
  {
    "name":"Analytics",
    "status":"Up",
    "rate":"300s",
    "uptime":{
      "Apr 09":100,
      "Apr 10":100,
      "Apr 11":100,
      "Apr 12":100,
      "Apr 13":100,
      "Apr 14":100,
      "Apr 15":100
    }
  },
  {
    "name":"Administration",
    "status":"Up",
    "rate":"300s",
    "uptime":{
      "Apr 09":100,
      "Apr 10":100,
      "Apr 11":100,
      "Apr 12":100,
      "Apr 13":100,
      "Apr 14":100,
      "Apr 15":100
    }
  },
  {
    "name":"APIs",
    "status":"Up",
    "rate":"300s",
    "uptime":{
      "Apr 09":100,
      "Apr 10":100,
      "Apr 11":100,
      "Apr 12":100,
      "Apr 13":100,
      "Apr 14":100,
      "Apr 15":100
    }
  }
]

Expected Errors

  • Error Code

    Summary

HTTP Example

	
    GET /1.1/helper/product_status HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/helper/product_status?"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/helper/product_status?",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/helper/product_status",
        dataType:"json",
        crossDomain:true,
        data:"",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = ""

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/helper/product_status", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/helper/product_status");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/helper/product_status");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/helper/product_status")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("")
      .asString();

	
	

helper/usage

GET

https://api.syn-finity.com/1.1/helper/usage

Example API Request

Resource information

Get a breakdown of the resources used by the current application

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

Example Request

[
  
]

Example Response

{
  "[0]":{
    "Resource":"\/1.1\/livechat\/transcript",
    "Calls":"20"
  },
  "[1]":{
    "Resource":"\/1.1\/livechat\/send",
    "Calls":"4"
  },
  "[2]":{
    "Resource":"\/1.1\/queue\/add",
    "Calls":"2"
  },
  "[3]":{
    "Resource":"\/1.1\/help\/usage",
    "Calls":"1"
  },
  "[4]":{
    "Total":27
  }
}

Expected Errors

  • Error Code

    Summary

  • 137

    CANNOT CONNECT

HTTP Example

	
    GET /1.1/helper/usage HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/helper/usage?"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/helper/usage?",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/helper/usage",
        dataType:"json",
        crossDomain:true,
        data:"",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = ""

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/helper/usage", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/helper/usage");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/helper/usage");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/helper/usage")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("")
      .asString();

	
	

helper/skills

GET

https://api.syn-finity.com/1.1/helper/skills

Example API Request

Resource information

Get a list of all your skills and associated channels.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

Example Request

[
  
]

Example Response

[
  {
    "id":304,
    "skill":"Specialism 1",
    "channels":[
      {
        "type":"Live chat"
      },
      {
        "type":"Email"
      },
      {
        "type":"Ticket"
      }
    ]
  },
  {
    "id":305,
    "skill":"Specialism 2",
    "channels":[
      
    ]
  },
  {
    "id":306,
    "skill":"Specialism 3",
    "channels":[
      
    ]
  },
  {
    "id":372,
    "skill":"Skill 4",
    "channels":[
      
    ]
  }
]

Expected Errors

  • Error Code

    Summary

  • 145

    CANNOT CONNECT

HTTP Example

	
    GET /1.1/helper/skills HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/helper/skills?"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/helper/skills?",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/helper/skills",
        dataType:"json",
        crossDomain:true,
        data:"",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = ""

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/helper/skills", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/helper/skills");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/helper/skills");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/helper/skills")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("")
      .asString();

	
	

helper/channels

GET

https://api.syn-finity.com/1.1/helper/channels

Example API Request

Resource information

Get a list of channels

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

Example Request

[
  
]

Example Response

[
  {
    "id":0,
    "channel":"livechat"
  },
  {
    "id":1,
    "channel":"callback"
  },
  {
    "id":2,
    "channel":"email"
  },
  {
    "id":3,
    "channel":"voip"
  },
  {
    "id":4,
    "channel":"video"
  },
  {
    "id":5,
    "channel":"whatsapp"
  },
  {
    "id":6,
    "channel":"skype_im"
  },
  {
    "id":7,
    "channel":"sms"
  },
  {
    "id":8,
    "channel":"twitter"
  },
  {
    "id":9,
    "channel":"ticket"
  },
  {
    "id":10,
    "channel":"Facebook"
  }
]

Expected Errors

  • Error Code

    Summary

  • 145

    CANNOT CONNECT

HTTP Example

	
    GET /1.1/helper/channels HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/helper/channels?"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/helper/channels?",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/helper/channels",
        dataType:"json",
        crossDomain:true,
        data:"",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = ""

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/helper/channels", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/helper/channels");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/helper/channels");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/helper/channels")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("")
      .asString();

	
	

helper/permissions

GET

https://api.syn-finity.com/1.1/helper/permissions

Example API Request

Resource information

Show the permissions for the current application

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

Example Request

[
  
]

Example Response

[
  {
    "standard":[
      "1.1\/external\/ad_serve",
      "1.1\/external\/article",
      "1.1\/external\/article_rate",
      "1.1\/external\/categories",
      "1.1\/external\/search",
      "1.1\/external\/session",
      "1.1\/external\/report",
      "1.1\/external\/session_check",
      "1.1\/external\/session_initation",
      "1.1\/external\/session_trail",
      "1.1\/external\/views",
      "1.1\/external\/all_faqs",
      "1.1\/helper\/channels",
      "1.1\/helper\/skills",
      "1.1\/helper\/usage",
      "1.1\/helper\/product_status",
      "1.1\/helper\/rate_limit_status",
      "1.1\/helper\/permissions"
    ],
    "bespoke":[
      
    ]
  }
]

Expected Errors

  • Error Code

    Summary

  • 145

    CANNOT CONNECT

HTTP Example

	
    GET /1.1/helper/permissions HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/helper/permissions?"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/helper/permissions?",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/helper/permissions",
        dataType:"json",
        crossDomain:true,
        data:"",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = ""

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/helper/permissions", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/helper/permissions");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/helper/permissions");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/helper/permissions")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("")
      .asString();

	
	

internal/notification

GET

https://api.syn-finity.com/1.1/internal/notification

Example API Request

Resource information

Returns the contents of a news announcment.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • id

    string

    Required

    The id of the news announcment

    Example 2187

Example Request

{
  "id":2187
}

Example Response

"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus id massa ac risus posuere mattis. Aliquam tincidunt ante nunc, non vehicula elit ultrices at. Praesent finibus quam ac dolor dignissim vestibulum. Fusce tempus laoreet diam iaculis tincidunt. Fusce aliquam neque libero, a sagittis quam finibus eu. Maecenas laoreet tellus vel lectus mollis, ac cursus libero blandit. Aliquam erat volutpat.\r\n\r\nNullam augue urna, sollicitudin vitae lacus in, consequat suscipit purus. Mauris semper dui ac dolor posuere sollicitudin. Phasellus mattis fringilla mauris id consectetur. Fusce interdum nisi sapien, nec gravida ligula bibendum non. Sed viverra mi ut nibh blandit pretium. Aenean egestas lectus quis velit finibus mattis. Pellentesque pretium venenatis risus, in consectetur est ultricies quis. Praesent in ligula libero.\r\n\r\nAliquam porttitor interdum elit eget maximus. Morbi pulvinar posuere consequat. Pellentesque nec magna congue, laoreet lacus ut, porttitor quam. Sed tincidunt libero dapibus, mattis erat eget, consequat nunc. Aliquam erat volutpat. Suspendisse enim magna, elementum eget quam cursus, accumsan luctus libero. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Vestibulum posuere sagittis eros, a pharetra erat lobortis maximus. Maecenas lacinia, dolor ac aliquam molestie, tellus lectus porta nulla, et malesuada magna erat nec justo. Sed congue ex vel ante viverra suscipit sit amet in ligula. Nunc viverra sagittis est, eget elementum justo accumsan sed. Nunc id dui felis. Praesent a diam dictum diam rhoncus pellentesque nec nec risus. Quisque lobortis tortor congue tincidunt consequat. Vestibulum tortor est, porttitor vitae neque et, commodo consectetur risus."

Expected Errors

  • Error Code

    Summary

HTTP Example

	
    GET /1.1/internal/notification HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    id=2187
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/internal/notification?id=2187"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/internal/notification?id=2187",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/internal/notification",
        dataType:"json",
        crossDomain:true,
        data:"id=2187",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "id=2187"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/internal/notification", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/internal/notification");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "id=2187");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/internal/notification");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "id=2187", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/internal/notification")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("id=2187")
      .asString();

	
	

internal/ongoing

GET

https://api.syn-finity.com/1.1/internal/ongoing

Example API Request

Resource information

Returns the number of chats currently in progress with the option of specifying a skill/topic. Optionally can be flagged to return all ongoing chats with all agents.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • token

    string

    Required

    The ID for the current session

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • skill

    string

    Optional

    Any skill you would prefer to filter the results by

    Example accounts

  • all

    bool

    Optional

    Flags the call to request just a specific user's ongoing chats. User information is gleaned from the session.

    Example 1

Example Request

[
  
]

Example Response

[
  
]

Expected Errors

  • Error Code

    Summary

HTTP Example

	
    GET /1.1/internal/ongoing HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    token=97B25C61-19FF-XXXX-3824-CAA8D691B010&skill=accounts&all=1
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/internal/ongoing?token=97B25C61-19FF-XXXX-3824-CAA8D691B010&skill=accounts&all=1"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/internal/ongoing?token=97B25C61-19FF-XXXX-3824-CAA8D691B010&skill=accounts&all=1",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/internal/ongoing",
        dataType:"json",
        crossDomain:true,
        data:"token=97B25C61-19FF-XXXX-3824-CAA8D691B010&skill=accounts&all=1",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "token=97B25C61-19FF-XXXX-3824-CAA8D691B010&skill=accounts&all=1"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/internal/ongoing", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/internal/ongoing");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "token=97B25C61-19FF-XXXX-3824-CAA8D691B010&skill=accounts&all=1");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/internal/ongoing");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "token=97B25C61-19FF-XXXX-3824-CAA8D691B010&skill=accounts&all=1", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/internal/ongoing")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("token=97B25C61-19FF-XXXX-3824-CAA8D691B010&skill=accounts&all=1")
      .asString();

	
	

internal/self_configure

GET

https://api.syn-finity.com/1.1/internal/self_configure

Example API Request

Resource information

Returns configuration and API data for a Shiva subdomain.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • subdomain

    string

    Required

    The name of the subdomain

    Example synthetix

Example Request

{
  "subdomain":"synthetix"
}

Example Response

{
  "application_key":"8418b1b10db43bd2d87cb1231hu1e1e0",
  "client_name":"synthetix",
  "consumer_key":"7648a1a95db65io3d43cb5321be1o5j1",
  "brand_image":"http:\/\/syn-document-manager.s3.amazonaws.com\/shiva_logos\/925088c00b3c09b58f56494e9d196432_Synthetix_Main_White.png",
  "group_chat":true,
  "inactivity_time":[
    "120",
    "240"
  ],
  "extra_wordage":{
    "login_fail":"Your login details are incorrect. Please contact an administrator.",
    "prelogin_notice":"Systems must only be used by authorised personnel"
  },
  "links":null
}

Expected Errors

  • Error Code

    Summary

  • 306

    NO KNOWLEDGE DATA

HTTP Example

	
    GET /1.1/internal/self_configure HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    subdomain=synthetix
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/internal/self_configure?subdomain=synthetix"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/internal/self_configure?subdomain=synthetix",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/internal/self_configure",
        dataType:"json",
        crossDomain:true,
        data:"subdomain=synthetix",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "subdomain=synthetix"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/internal/self_configure", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/internal/self_configure");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "subdomain=synthetix");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/internal/self_configure");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "subdomain=synthetix", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/internal/self_configure")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("subdomain=synthetix")
      .asString();

	
	

internal/summarystats

GET

https://api.syn-finity.com/1.1/internal/summarystats

Example API Request

Resource information

Return a list of statistics from various channels

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

Example Request

[
  
]

Example Response

{
  "overview":{
    "today":{
      "email":{
        "avg_interactions":1,
        "avg_reply_time":"00:00",
        "insla":0,
        "!insla":0,
        "new":0,
        "updated":0,
        "closed":0
      },
      "ticket":{
        "avg_interactions":1,
        "avg_reply_time":"00:20",
        "insla":10,
        "!insla":0,
        "new":0,
        "updated":0,
        "closed":0
      },
      "livechat":{
        "chats_taken":3467,
        "chats_missed":536,
        "chats_abandoned":177,
        "avg_handeling_time":"20:43:27",
        "avg_time_to_accept":"04:04:23"
      }
    }
  },
  "user":[
    {
      "Name":"Peter",
      "tickets":{
        "insla":100,
        "!insla":0,
        "avg_reply_time":"00:20"
      },
      "livechat":{
        "chats_taken":9,
        "chats_rejected":0,
        "avg_handeling_time":"00:07:26",
        "avg_time_to_accept":"00:00:14",
        "feedback":[
          
        ]
      }
    },
    {
      "Name":"Alan",
      "livechat":{
        "chats_taken":242,
        "chats_rejected":9,
        "avg_handeling_time":"15:03:18",
        "avg_time_to_accept":"00:00:09",
        "feedback":[
          
        ]
      }
    },
    {
      "Name":"Baby Gurl",
      "livechat":{
        "chats_taken":90,
        "chats_rejected":5,
        "avg_handeling_time":"03:19:42",
        "avg_time_to_accept":"23:59:29",
        "feedback":[
          
        ]
      }
    },
    {
      "Name":"Steve",
      "livechat":{
        "chats_taken":14,
        "chats_rejected":0,
        "avg_handeling_time":"00:04:24",
        "avg_time_to_accept":"00:00:09",
        "feedback":[
          
        ]
      }
    }
  ]
}

Expected Errors

  • Error Code

    Summary

  • 163

    NO SLA DATA

HTTP Example

	
    GET /1.1/internal/summarystats HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/internal/summarystats?"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/internal/summarystats?",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/internal/summarystats",
        dataType:"json",
        crossDomain:true,
        data:"",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = ""

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/internal/summarystats", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/internal/summarystats");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/internal/summarystats");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/internal/summarystats")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("")
      .asString();

	
	

internal/team

GET

https://api.syn-finity.com/1.1/internal/team

Example API Request

Resource information

Returns a list of the currently logged in live chat operators with their current status. Optionally can be restricted to a single user.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • username

    string

    Optional

    User to return data about.

    Example bob234

Example Request

[
  
]

Example Response

{
  "teammates":[
    {
      "userid":2434,
      "username":"george",
      "firstname":"Marvin",
      "lastname":"the Paranoid Android",
      "nickname":null,
      "avatar":"https:\/\/s3-eu-west-1.amazonaws.com\/syn-images\/avatars\/",
      "suspended":false,
      "status":"Online",
      "skills":[
        {
          "id":467,
          "skill":"Skill 1"
        },
        {
          "id":468,
          "skill":"Skill 2"
        },
        {
          "id":469,
          "skill":"Skill 3"
        }
      ]
    }
  ],
  "offline":0,
  "online":1,
  "suspended":0
}

Expected Errors

  • Error Code

    Summary

HTTP Example

	
    GET /1.1/internal/team HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    username=bob234
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/internal/team?username=bob234"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/internal/team?username=bob234",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/internal/team",
        dataType:"json",
        crossDomain:true,
        data:"username=bob234",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "username=bob234"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/internal/team", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/internal/team");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "username=bob234");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/internal/team");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "username=bob234", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/internal/team")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("username=bob234")
      .asString();

	
	

livechat/availability

POST

https://api.syn-finity.com/1.1/livechat/availability

Example API Request

Resource information

Returns information about which skills have agents online and which have chat capacity available.Includes information about channels.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • skill

    string

    Optional

    Any skill you would prefer to filter the results by

    Example accounts

Example Request

{
  "skill":"accounts"
}

Example Response

[
  {
    "Specialism":"Specialism 1",
    "Online":true,
    "AtCapacity":false
  },
  {
    "Specialism":"Specialism 2",
    "Online":false,
    "AtCapacity":false
  },
  {
    "Specialism":"Specialism 3",
    "Online":true,
    "AtCapacity":true
  },
  {
    "Specialism":"Skill 4",
    "Online":false,
    "AtCapacity":false
  }
]

Expected Errors

  • Error Code

    Summary

  • 148

    MISSING OR MALFORMED SKILL

HTTP Example

	
    POST /1.1/livechat/availability HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    skill=accounts
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/livechat/availability?skill=accounts"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/livechat/availability?skill=accounts",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/livechat/availability",
        dataType:"json",
        crossDomain:true,
        data:"skill=accounts",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "skill=accounts"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/livechat/availability", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/livechat/availability");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "skill=accounts");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/livechat/availability");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "skill=accounts", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/livechat/availability")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("skill=accounts")
      .asString();

	
	

livechat/details

POST

https://api.syn-finity.com/1.1/livechat/details

Example API Request

Resource information

Returns the current status of any chat.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • session

    string

    Required

    The ID for your current external session

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • token

    string

    Required

    The ID for your current internal session

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • uniQref

    string

    Required

    The ID for the chat being investigated. Only required if TOKEN beinhg sent in for INTERNAL session

    Example kdj385kdgGjk

Example Request

{
  "session":"97B25C61-19FF-XXXX-3824-CAA8D691B010"
}

Example Response

{
  "current_status":"Completed"
}

Expected Errors

  • Error Code

    Summary

  • 106

    MISSING PARAMETER

  • 147

    VOID ID

  • 145

    CANNOT CONNECT

HTTP Example

	
    POST /1.1/livechat/details HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=kdj385kdgGjk
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/livechat/details?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=kdj385kdgGjk"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/livechat/details?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=kdj385kdgGjk",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/livechat/details",
        dataType:"json",
        crossDomain:true,
        data:"session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=kdj385kdgGjk",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=kdj385kdgGjk"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/livechat/details", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/livechat/details");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=kdj385kdgGjk");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/livechat/details");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=kdj385kdgGjk", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/livechat/details")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=kdj385kdgGjk")
      .asString();

	
	

livechat/emojiscore

PUT

https://api.syn-finity.com/1.1/livechat/emojiscore

Example API Request

Resource information

Allows a message to be scored individually by the customer by the use of appropriately selected emojis (the selection of which is entirely discretionary). Allows for scores to be sent from -5 through to 5. 5 would normally equate to happiness, while -5 would equate to sadness.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • session

    string

    Required

    The ID for your current session

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • score

    integer

    Required

    Example 3

  • messageid

    string

    Required

    the ID of the message to be scored

    Example 6

Example Request

{
  "session":"97B25C61-19FF-XXXX-3824-CAA8D691B010",
  "score":3,
  "messageid":"6"
}

Example Response

{
  "score":true
}

Expected Errors

  • Error Code

    Summary

  • 106

    MISSING PARAMETER

  • 147

    VOID ID

HTTP Example

	
    PUT /1.1/livechat/emojiscore HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    session=97B25C61-19FF-XXXX-3824-CAA8D691B010&score=3&messageid=6
	
	

CURL Example

	
    curl --request PUT
    --url "https://api.syn-finity.com/1.1/livechat/emojiscore?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&score=3&messageid=6"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/livechat/emojiscore?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&score=3&messageid=6",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "PUT",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"PUT",
        url:"https://api.syn-finity.com/1.1/livechat/emojiscore",
        dataType:"json",
        crossDomain:true,
        data:"session=97B25C61-19FF-XXXX-3824-CAA8D691B010&score=3&messageid=6",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&score=3&messageid=6"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("PUT", "/1.1/livechat/emojiscore", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/livechat/emojiscore");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&score=3&messageid=6");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/livechat/emojiscore");
    var request = new RestRequest(Method.PUT);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&score=3&messageid=6", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.PUT("https://api.syn-finity.com/1.1/livechat/emojiscore")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("session=97B25C61-19FF-XXXX-3824-CAA8D691B010&score=3&messageid=6")
      .asString();

	
	

livechat/end

POST

https://api.syn-finity.com/1.1/livechat/end

Example API Request

Resource information

Allows a contact (normally live chat) to be gracefully ended. Returns a confirmatory message and the feedback questions and (where appropriate) multiple choice answers (with IDs) to be offered to the customer at the end of the chat. Where ‘null’ is presented as the answer, this will enable the customer to provide free textual feedback.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • session

    string

    Required

    The ID for your current EXTERNAL session. EITHER token or session required, according to whether the call is from the customer (external) or agent console (internal)

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • reason

    string

    Required

    The reason for the chat being ended. 14 => "Ongoing chat forcefully ended by system", 15 => "Operator Ended Chat", 16 => "User clicked End Chat button", 17 => "User lost connectivity", 18 => "User shut down chat application without ending chat"

    Example 16

  • token

    string

    Required

    The ID for your current INTERNAL session. EITHER token or session required, according to whether the call is from the customer (external) or agent console (internal)

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

Example Request

{
  "session":"97B25C61-19FF-XXXX-3824-CAA8D691B010",
  "reason":16
}

Example Response

{
  "end":true,
  "feedback":[
    {
      "Question":"Were all your questions answered?",
      "ID":"Q1",
      "Answers":[
        "Yes",
        "No"
      ]
    },
    {
      "Question":"How would you rate the chat?",
      "ID":"Q2",
      "Answers":[
        "Good",
        "Average",
        "Poor"
      ]
    },
    {
      "Question":"Would you use this service again?",
      "ID":"Q3",
      "Answers":[
        "Yes",
        "No"
      ]
    },
    {
      "Question":"Please let us have any other feedback you'd like to give us.",
      "ID":"Q4",
      "Answers":[
        null
      ]
    }
  ]
}

Expected Errors

  • Error Code

    Summary

  • 106

    MISSING PARAMETER

  • 144

    CANNOT CONNECT

  • 147

    VOID ID

HTTP Example

	
    POST /1.1/livechat/end HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    session=97B25C61-19FF-XXXX-3824-CAA8D691B010&reason=16&token=97B25C61-19FF-XXXX-3824-CAA8D691B010
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/livechat/end?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&reason=16&token=97B25C61-19FF-XXXX-3824-CAA8D691B010"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/livechat/end?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&reason=16&token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/livechat/end",
        dataType:"json",
        crossDomain:true,
        data:"session=97B25C61-19FF-XXXX-3824-CAA8D691B010&reason=16&token=97B25C61-19FF-XXXX-3824-CAA8D691B010",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&reason=16&token=97B25C61-19FF-XXXX-3824-CAA8D691B010"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/livechat/end", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/livechat/end");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&reason=16&token=97B25C61-19FF-XXXX-3824-CAA8D691B010");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/livechat/end");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&reason=16&token=97B25C61-19FF-XXXX-3824-CAA8D691B010", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/livechat/end")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("session=97B25C61-19FF-XXXX-3824-CAA8D691B010&reason=16&token=97B25C61-19FF-XXXX-3824-CAA8D691B010")
      .asString();

	
	

livechat/feedback

GET

https://api.syn-finity.com/1.1/livechat/feedback

Example API Request

Resource information

This resource provides the feedback questions and multiple choice answers where appropriate. To be used where an operator ends a chat.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

Example Request

[
  
]

Example Response

{
  "feedback":[
    {
      "Question":"Were all your questions answered?",
      "ID":"Q1",
      "Answers":[
        "Yes",
        "No"
      ]
    },
    {
      "Question":"How would you rate the chat?",
      "ID":"Q2",
      "Answers":[
        "Good",
        "Average",
        "Poor"
      ]
    },
    {
      "Question":"Would you use this service again?",
      "ID":"Q3",
      "Answers":[
        "Yes",
        "No"
      ]
    },
    {
      "Question":"Please let us have any other feedback you'd like to give us.",
      "ID":"Q4",
      "Answers":[
        null
      ]
    }
  ]
}

Expected Errors

  • Error Code

    Summary

HTTP Example

	
    GET /1.1/livechat/feedback HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/livechat/feedback?"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/livechat/feedback?",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/livechat/feedback",
        dataType:"json",
        crossDomain:true,
        data:"",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = ""

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/livechat/feedback", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/livechat/feedback");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/livechat/feedback");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/livechat/feedback")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("")
      .asString();

	
	

livechat/feedback

POST

https://api.syn-finity.com/1.1/livechat/feedback

Example API Request

Resource information

Allows the customer’s answers to feedback questions to be stored against their contact. If a multiple choice answer is required, the answers must match one of the multiple choices offered against the question ID. If full text answers are indicated, any textual answer will be accepted.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • session

    string

    Required

    The ID for your current session

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • q1

    string

    Required

    The feedback against Q1.

    Example Yes

  • q2

    string

    Optional

    The feedback against Q2.

    Example Great

  • q3

    string

    Optional

    The feedback against Q3.

    Example No

  • q4

    string

    Optional

    The feedback against Q4.

    Example Could have been slightly less efficient

  • q5

    string

    Optional

    The feedback against Q5.

    Example Yes

Example Request

{
  "session":"97B25C61-19FF-XXXX-3824-CAA8D691B010",
  "q1":"Yes",
  "q2":"Great",
  "q3":"No",
  "q4":"Very helpful",
  "q5":"Yes"
}

Example Response

{
  "feedback_successful":true
}

Expected Errors

  • Error Code

    Summary

HTTP Example

	
    POST /1.1/livechat/feedback HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    session=97B25C61-19FF-XXXX-3824-CAA8D691B010&q1=Yes&q2=Great&q3=No&q4=Could+have+been+slightly+less+efficient&q5=Yes
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/livechat/feedback?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&q1=Yes&q2=Great&q3=No&q4=Could+have+been+slightly+less+efficient&q5=Yes"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/livechat/feedback?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&q1=Yes&q2=Great&q3=No&q4=Could+have+been+slightly+less+efficient&q5=Yes",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/livechat/feedback",
        dataType:"json",
        crossDomain:true,
        data:"session=97B25C61-19FF-XXXX-3824-CAA8D691B010&q1=Yes&q2=Great&q3=No&q4=Could+have+been+slightly+less+efficient&q5=Yes",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&q1=Yes&q2=Great&q3=No&q4=Could+have+been+slightly+less+efficient&q5=Yes"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/livechat/feedback", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/livechat/feedback");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&q1=Yes&q2=Great&q3=No&q4=Could+have+been+slightly+less+efficient&q5=Yes");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/livechat/feedback");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&q1=Yes&q2=Great&q3=No&q4=Could+have+been+slightly+less+efficient&q5=Yes", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/livechat/feedback")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("session=97B25C61-19FF-XXXX-3824-CAA8D691B010&q1=Yes&q2=Great&q3=No&q4=Could+have+been+slightly+less+efficient&q5=Yes")
      .asString();

	
	

livechat/keypress

GET

https://api.syn-finity.com/1.1/livechat/keypress

Example API Request

Resource information

Retrieve the agent's state (i.e. typing or not typing, thinking or not thinking) or the customer's live key feed.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • session

    string

    Required

    The ID for your current EXTERNAL session. EITHER session or token required according to whether the session is being called from a customer interface or agent console.

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • token

    string

    Required

    The ID for your current INTERNAL session.EITHER session or token required according to whether the session is being called from a customer interface or agent console.

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • uniQref

    string

    Required

    The ID for your current chat. Required to be sent in if token passed in when session is being called from an INTERNAL agent console.

    Example uroy856043jk

Example Request

{
  "session":"97B25C61-19FF-XXXX-3824-CAA8D691B010",
  "sender":"CL"
}

Example Response

{
  "results":true
}

Expected Errors

  • Error Code

    Summary

  • 147

    VOID ID

HTTP Example

	
    GET /1.1/livechat/keypress HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=uroy856043jk
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/livechat/keypress?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=uroy856043jk"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/livechat/keypress?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=uroy856043jk",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/livechat/keypress",
        dataType:"json",
        crossDomain:true,
        data:"session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=uroy856043jk",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=uroy856043jk"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/livechat/keypress", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/livechat/keypress");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=uroy856043jk");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/livechat/keypress");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=uroy856043jk", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/livechat/keypress")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=uroy856043jk")
      .asString();

	
	

livechat/keypress

PUT

https://api.syn-finity.com/1.1/livechat/keypress

Example API Request

Resource information

Indicate whether the user or agent is typing. if the sender is 'OP' this will trigger a true state. If the sender is 'CL', 'message' must be sent in the payload.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • session

    string

    Required

    The ID for your current session

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • sender

    string

    Required

    CL || OP

    Example CL

  • message

    string

    Required

    The live stream of keypresses. This is only required if the sender is 'CL'

    Example Hello, Wor

  • uniQref

    string

    Required

    ID of the chat. To be provided if sender is OP

    Example jclfmgu830o

Example Request

{
  "session":"97B25C61-19FF-XXXX-3824-CAA8D691B010",
  "sender":"CL",
  "message":"Hello, World"
}

Example Response

{
  "results":true
}

Expected Errors

  • Error Code

    Summary

HTTP Example

	
    PUT /1.1/livechat/keypress HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    session=97B25C61-19FF-XXXX-3824-CAA8D691B010&sender=CL&message=Hello%2C+Wor&uniQref=jclfmgu830o
	
	

CURL Example

	
    curl --request PUT
    --url "https://api.syn-finity.com/1.1/livechat/keypress?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&sender=CL&message=Hello%2C+Wor&uniQref=jclfmgu830o"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/livechat/keypress?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&sender=CL&message=Hello%2C+Wor&uniQref=jclfmgu830o",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "PUT",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"PUT",
        url:"https://api.syn-finity.com/1.1/livechat/keypress",
        dataType:"json",
        crossDomain:true,
        data:"session=97B25C61-19FF-XXXX-3824-CAA8D691B010&sender=CL&message=Hello%2C+Wor&uniQref=jclfmgu830o",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&sender=CL&message=Hello%2C+Wor&uniQref=jclfmgu830o"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("PUT", "/1.1/livechat/keypress", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/livechat/keypress");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&sender=CL&message=Hello%2C+Wor&uniQref=jclfmgu830o");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/livechat/keypress");
    var request = new RestRequest(Method.PUT);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&sender=CL&message=Hello%2C+Wor&uniQref=jclfmgu830o", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.PUT("https://api.syn-finity.com/1.1/livechat/keypress")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("session=97B25C61-19FF-XXXX-3824-CAA8D691B010&sender=CL&message=Hello%2C+Wor&uniQref=jclfmgu830o")
      .asString();

	
	

livechat/recieve

POST

https://api.syn-finity.com/1.1/livechat/recieve

Example API Request

Resource information

This allows all messages in a specified contact to be received. This will need to be called regularly throughout a live chat to check for responses.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • session

    string

    Required

    The ID for your current session

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • timezone

    string

    Optional

    The timezone you wish to convert the time to. Can be in either formats Europe/London OR GMT+2

    Example Antarctica/Casey

Example Request

{
  "session":"97B25C61-19FF-XXXX-3824-CAA8D691B010"
}

Example Response

{
  "Message Count":2,
  "Messages":[
    [
      {
        "type":"message",
        "Received At":"13\/01\/2016 15:46:59",
        "Sender":"Agent",
        "Name":"Luke",
        "Message":"Hello. My name is Luke and I work for Synthetix. How can I help you, today?",
        "Attachments":"",
        "profileimage":null
      },
      {
        "type":"message",
        "Received At":"13\/01\/2016 15:47:27",
        "Sender":"Client",
        "Name":"Luke (API Test)",
        "Message":"Did you get this?",
        "Attachments":"",
        "profileimage":null
      }
    ]
  ]
}

Expected Errors

  • Error Code

    Summary

  • 147

    VOID ID

HTTP Example

	
    POST /1.1/livechat/recieve HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    session=97B25C61-19FF-XXXX-3824-CAA8D691B010&timezone=Antarctica%2FCasey
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/livechat/recieve?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&timezone=Antarctica%2FCasey"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/livechat/recieve?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&timezone=Antarctica%2FCasey",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/livechat/recieve",
        dataType:"json",
        crossDomain:true,
        data:"session=97B25C61-19FF-XXXX-3824-CAA8D691B010&timezone=Antarctica%2FCasey",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&timezone=Antarctica%2FCasey"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/livechat/recieve", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/livechat/recieve");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&timezone=Antarctica%2FCasey");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/livechat/recieve");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&timezone=Antarctica%2FCasey", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/livechat/recieve")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("session=97B25C61-19FF-XXXX-3824-CAA8D691B010&timezone=Antarctica%2FCasey")
      .asString();

	
	

livechat/send

POST

https://api.syn-finity.com/1.1/livechat/send

Example API Request

Resource information

Allows a message to be sent. When successfully sent, returns a confirmatory response.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • message

    string

    Required

    The text of the message being sent.

    Example Hello world

  • confidential

    bool

    Optional

    Flag to indicate a confidential message (only applicable for EXTERNAL messages)

    Example 1

  • attachments

    files

    Optional

    Attachments

    Example

  • session

    string

    Required

    The ID for your current EXTERNAL session

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • token

    string

    Required

    The ID for your current INTERNAL session. EITHER session or token should be passed in according to whether the resource is being called from an external (customer) interface or internal (agent) console. If token passed in, uniQref should also be included.

    Example cl

  • uniQref

    string

    Required

    ID for specific chat in which the message being sent belongs.

    Example jdo34786o93

Example Request

{
  "session":"97B25C61-19FF-XXXX-3824-CAA8D691B010",
  "message":"Hello, world."
}

Example Response

{
  "sent":true
}

Expected Errors

  • Error Code

    Summary

  • 147

    VOID ID

HTTP Example

	
    POST /1.1/livechat/send HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    message=Hello+world&confidential=1&attachments=&session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=cl&uniQref=jdo34786o93
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/livechat/send?message=Hello+world&confidential=1&attachments=&session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=cl&uniQref=jdo34786o93"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/livechat/send?message=Hello+world&confidential=1&attachments=&session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=cl&uniQref=jdo34786o93",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/livechat/send",
        dataType:"json",
        crossDomain:true,
        data:"message=Hello+world&confidential=1&attachments=&session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=cl&uniQref=jdo34786o93",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "message=Hello+world&confidential=1&attachments=&session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=cl&uniQref=jdo34786o93"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/livechat/send", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/livechat/send");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "message=Hello+world&confidential=1&attachments=&session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=cl&uniQref=jdo34786o93");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/livechat/send");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "message=Hello+world&confidential=1&attachments=&session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=cl&uniQref=jdo34786o93", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/livechat/send")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("message=Hello+world&confidential=1&attachments=&session=97B25C61-19FF-XXXX-3824-CAA8D691B010&token=cl&uniQref=jdo34786o93")
      .asString();

	
	

livechat/transcript

GET

https://api.syn-finity.com/1.1/livechat/transcript

Example API Request

Resource information

Returns all messages, timings and other details associated with a particular chat. This could be used in conjunction with the livechat/chatids API.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • session

    string

    Required

    The ID for your current session

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • send

    boolean

    Optional

    if this is set to true, an email will be sent to the customer with the transcript. Please note that the settings for outgoing emails must be complete in the control panel before emails will be sent.

    Example 1

Example Request

{
  "session":"97B25C61-19FF-XXXX-3824-CAA8D691B010"
}

Example Response

{
  "sent":true
}

Expected Errors

  • Error Code

    Summary

  • 147

    VOID ID

HTTP Example

	
    GET /1.1/livechat/transcript HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    session=97B25C61-19FF-XXXX-3824-CAA8D691B010&send=1
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/livechat/transcript?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&send=1"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/livechat/transcript?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&send=1",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/livechat/transcript",
        dataType:"json",
        crossDomain:true,
        data:"session=97B25C61-19FF-XXXX-3824-CAA8D691B010&send=1",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&send=1"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/livechat/transcript", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/livechat/transcript");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&send=1");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/livechat/transcript");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&send=1", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/livechat/transcript")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("session=97B25C61-19FF-XXXX-3824-CAA8D691B010&send=1")
      .asString();

	
	

queue/add

POST

https://api.syn-finity.com/1.1/queue/add

Example API Request

Resource information

Deprecated - Use entity instead. This resource allows a new contact of various types to be added to the unified Queue system.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • channel

    integer

    Required

    The type of contact being added 0 => 'Live chat', 1 => 'Callback', 2 => 'Email', 3 => 'VOIP', 4 => 'Video', 5 => 'WhatsApp', 6 => 'Skype IM', 7 => 'SMS', 8 => 'Twitter', 9 => 'Ticket',

    Example 0

  • brand

    string

    Optional

    If your chat system is run using one console, but covering several brands, this enables chats to be flagged up as emanating from a particular brand to the agents and for reporting purposes.

    Example Argos

  • firstname

    string

    Required

    EITHER the first name of the customer OR the full name of the customer according to preference.

    Example Gary

  • surname

    string

    Required

    If you are passing in the first name of the customer, include their surname within this parameter.

    Example McKenzie

  • skill

    string

    Required

    The specified skill for which the contact is being created.

    Example Accounts

  • email

    string

    Optional

    The customer’s email address

    Example gary_mckenzie@gmail.com

  • phone

    string

    Optional

    The customer’s telephone number

    Example 7856965821

  • account_number

    string

    Optional

    An account number, customer reference number or other identifier

    Example 9405940 3845039 930405

  • message

    string

    Optional

    The initiating message of the contact – IF present. Please note, this should NEVER be blank. If there is no message, the parameter should not be passed.

    Example Hello world

  • latlong

    string

    Optional

    Latitude and longitude of the customer – IF available. Please note, this should NEVER be blank. If there is no location available, the parameter should not be passed. Should passed as comma separated values, latitude followed by longitude.

    Example -39.236474, 175.560343

  • page_source

    string

    Optional

    The source URL from which the contact has been requested. Please note, this should NEVER be blank. If there is no source available, the parameter should not be passed.

    Example http://www.synthetix.com

Example Request

{
  "channel":0,
  "brand":"Synthetix",
  "firstname":"Richard",
  "surname":"Giraffa",
  "skill":"Specialism 1",
  "email":"r.giraffa@gmail.com"
}

Example Response

{
  "session":"97B25C61-19FF-XXXX-3824-CAA8D691B010"
}

Expected Errors

  • Error Code

    Summary

  • 106

    MISSING PARAMETER

  • 144

    CANNOT CONNECT

  • 149

    INVALID SKILL

  • 146

    INVALID CHANNEL

HTTP Example

	
    POST /1.1/queue/add HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    channel=0&brand=Argos&firstname=Gary&surname=McKenzie&skill=Accounts&email=gary_mckenzie%40gmail.com&phone=7856965821&account_number=9405940+3845039+930405&message=Hello+world&latlong=-39.236474%2C+175.560343&page_source=http%3A%2F%2Fwww.synthetix.com
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/queue/add?channel=0&brand=Argos&firstname=Gary&surname=McKenzie&skill=Accounts&email=gary_mckenzie%40gmail.com&phone=7856965821&account_number=9405940+3845039+930405&message=Hello+world&latlong=-39.236474%2C+175.560343&page_source=http%3A%2F%2Fwww.synthetix.com"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/queue/add?channel=0&brand=Argos&firstname=Gary&surname=McKenzie&skill=Accounts&email=gary_mckenzie%40gmail.com&phone=7856965821&account_number=9405940+3845039+930405&message=Hello+world&latlong=-39.236474%2C+175.560343&page_source=http%3A%2F%2Fwww.synthetix.com",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/queue/add",
        dataType:"json",
        crossDomain:true,
        data:"channel=0&brand=Argos&firstname=Gary&surname=McKenzie&skill=Accounts&email=gary_mckenzie%40gmail.com&phone=7856965821&account_number=9405940+3845039+930405&message=Hello+world&latlong=-39.236474%2C+175.560343&page_source=http%3A%2F%2Fwww.synthetix.com",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "channel=0&brand=Argos&firstname=Gary&surname=McKenzie&skill=Accounts&email=gary_mckenzie%40gmail.com&phone=7856965821&account_number=9405940+3845039+930405&message=Hello+world&latlong=-39.236474%2C+175.560343&page_source=http%3A%2F%2Fwww.synthetix.com"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/queue/add", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/queue/add");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "channel=0&brand=Argos&firstname=Gary&surname=McKenzie&skill=Accounts&email=gary_mckenzie%40gmail.com&phone=7856965821&account_number=9405940+3845039+930405&message=Hello+world&latlong=-39.236474%2C+175.560343&page_source=http%3A%2F%2Fwww.synthetix.com");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/queue/add");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "channel=0&brand=Argos&firstname=Gary&surname=McKenzie&skill=Accounts&email=gary_mckenzie%40gmail.com&phone=7856965821&account_number=9405940+3845039+930405&message=Hello+world&latlong=-39.236474%2C+175.560343&page_source=http%3A%2F%2Fwww.synthetix.com", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/queue/add")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("channel=0&brand=Argos&firstname=Gary&surname=McKenzie&skill=Accounts&email=gary_mckenzie%40gmail.com&phone=7856965821&account_number=9405940+3845039+930405&message=Hello+world&latlong=-39.236474%2C+175.560343&page_source=http%3A%2F%2Fwww.synthetix.com")
      .asString();

	
	

queue/display

GET

https://api.syn-finity.com/1.1/queue/display

Example API Request

Resource information

Displays the current state of the UniQueue. This will include all contact requests, date and time of start, contact type, customer name and UniQueue reference for each contact. Optionally can be filtered by contact type, to show e.g. all live chats in the queue, brand and / or skill.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • token

    string

    Required

    The ID for the current session

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • channel

    integer

    Optional

    The type of contact being checked.

    Example 0

  • brand

    string

    Optional

    If your system is run using one console, but covering several brands, will enable contacts to be filtered by brand.

    Example Argos

  • skill

    string

    Optional

    Any skill you wish your list to be filtered by.

    Example Accounts

Example Request

{
  "channel":0,
  "brand":"Synthetix",
  "skill":"Accounts"
}

Example Response

[
  
]

Expected Errors

  • Error Code

    Summary

  • 145

    CANNOT CONNECT

HTTP Example

	
    GET /1.1/queue/display HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    token=97B25C61-19FF-XXXX-3824-CAA8D691B010&channel=0&brand=Argos&skill=Accounts
	
	

CURL Example

	
    curl --request GET
    --url "https://api.syn-finity.com/1.1/queue/display?token=97B25C61-19FF-XXXX-3824-CAA8D691B010&channel=0&brand=Argos&skill=Accounts"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/queue/display?token=97B25C61-19FF-XXXX-3824-CAA8D691B010&channel=0&brand=Argos&skill=Accounts",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "GET",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"GET",
        url:"https://api.syn-finity.com/1.1/queue/display",
        dataType:"json",
        crossDomain:true,
        data:"token=97B25C61-19FF-XXXX-3824-CAA8D691B010&channel=0&brand=Argos&skill=Accounts",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "token=97B25C61-19FF-XXXX-3824-CAA8D691B010&channel=0&brand=Argos&skill=Accounts"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("GET", "/1.1/queue/display", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/queue/display");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "token=97B25C61-19FF-XXXX-3824-CAA8D691B010&channel=0&brand=Argos&skill=Accounts");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/queue/display");
    var request = new RestRequest(Method.GET);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "token=97B25C61-19FF-XXXX-3824-CAA8D691B010&channel=0&brand=Argos&skill=Accounts", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.GET("https://api.syn-finity.com/1.1/queue/display")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("token=97B25C61-19FF-XXXX-3824-CAA8D691B010&channel=0&brand=Argos&skill=Accounts")
      .asString();

	
	

queue/entity

POST

https://api.syn-finity.com/1.1/queue/entity

Example API Request

Resource information

This resource allows a new contact of various types to be added to the unified Queue system.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • token

    string

    Required

    The ID for the current session

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • channel

    integer

    Required

    The type of contact being added 0 => 'Live chat', 1 => 'Callback', 2 => 'Email', 3 => 'VOIP', 4 => 'Video', 5 => 'WhatsApp', 6 => 'Skype IM', 7 => 'SMS', 8 => 'Twitter', 9 => 'Ticket',

    Example 0

  • brand

    string

    Optional

    If your chat system is run using one console, but covering several brands, this enables chats to be flagged up as emanating from a particular brand to the agents and for reporting purposes.

    Example Argos

  • firstname

    string

    Required

    EITHER the first name of the customer OR the full name of the customer according to preference.

    Example Gary

  • surname

    string

    Required

    If you are passing in the first name of the customer, include their surname within this parameter.

    Example McKenzie

  • skill

    string

    Required

    The specified skill for which the contact is being created.

    Example Accounts

  • email

    string

    Optional

    The customer’s email address

    Example gary_mckenzie@gmail.com

  • phone

    string

    Optional

    The customer’s telephone number

    Example 7856965821

  • account_number

    string

    Optional

    An account number, customer reference number or other identifier

    Example 9405940 3845039 930405

  • message

    string

    Optional

    The initiating message of the contact – IF present. Please note, this should NEVER be blank. If there is no message, the parameter should not be passed.

    Example Hello world

  • latlong

    string

    Optional

    Latitude and longitude of the customer – IF available. Please note, this should NEVER be blank. If there is no location available, the parameter should not be passed. Should passed as comma separated values, latitude followed by longitude.

    Example -39.236474, 175.560343

  • page_source

    string

    Optional

    The source URL from which the contact has been requested. Please note, this should NEVER be blank. If there is no source available, the parameter should not be passed.

    Example http://www.synthetix.com

  • trigger

    string

    Optional

    The name of the trigger that was used to generate the entity

    Example home_page

  • timeslot

    string

    Required

    Required for generating new callback entities.

    Example timeslot

  • source_device

    string

    Optional

    Type of device being used to generate entity.

    Example

  • subject

    string

    Required

    Required for generating new email entities.

    Example Website contact

  • attachments

    string

    Optional

    Only applicable for new email entities.

    Example

Example Request

{
  "channel":0,
  "brand":"Synthetix",
  "firstname":"Richard",
  "surname":"Giraffa",
  "skill":"Specialism 1",
  "email":"r.giraffa@gmail.com"
}

Example Response

{
  "session":"97B25C61-19FF-XXXX-3824-CAA8D691B010"
}

Expected Errors

  • Error Code

    Summary

  • 149

    INVALID SKILL

  • 146

    INVALID CHANNEL

HTTP Example

	
    POST /1.1/queue/entity HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    token=97B25C61-19FF-XXXX-3824-CAA8D691B010&channel=0&brand=Argos&firstname=Gary&surname=McKenzie&skill=Accounts&email=gary_mckenzie%40gmail.com&phone=7856965821&account_number=9405940+3845039+930405&message=Hello+world&latlong=-39.236474%2C+175.560343&page_source=http%3A%2F%2Fwww.synthetix.com&trigger=home_page×lot=timeslot&source_device=&subject=Website+contact&attachments=
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/queue/entity?token=97B25C61-19FF-XXXX-3824-CAA8D691B010&channel=0&brand=Argos&firstname=Gary&surname=McKenzie&skill=Accounts&email=gary_mckenzie%40gmail.com&phone=7856965821&account_number=9405940+3845039+930405&message=Hello+world&latlong=-39.236474%2C+175.560343&page_source=http%3A%2F%2Fwww.synthetix.com&trigger=home_page×lot=timeslot&source_device=&subject=Website+contact&attachments="
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/queue/entity?token=97B25C61-19FF-XXXX-3824-CAA8D691B010&channel=0&brand=Argos&firstname=Gary&surname=McKenzie&skill=Accounts&email=gary_mckenzie%40gmail.com&phone=7856965821&account_number=9405940+3845039+930405&message=Hello+world&latlong=-39.236474%2C+175.560343&page_source=http%3A%2F%2Fwww.synthetix.com&trigger=home_page×lot=timeslot&source_device=&subject=Website+contact&attachments=",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/queue/entity",
        dataType:"json",
        crossDomain:true,
        data:"token=97B25C61-19FF-XXXX-3824-CAA8D691B010&channel=0&brand=Argos&firstname=Gary&surname=McKenzie&skill=Accounts&email=gary_mckenzie%40gmail.com&phone=7856965821&account_number=9405940+3845039+930405&message=Hello+world&latlong=-39.236474%2C+175.560343&page_source=http%3A%2F%2Fwww.synthetix.com&trigger=home_page×lot=timeslot&source_device=&subject=Website+contact&attachments=",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "token=97B25C61-19FF-XXXX-3824-CAA8D691B010&channel=0&brand=Argos&firstname=Gary&surname=McKenzie&skill=Accounts&email=gary_mckenzie%40gmail.com&phone=7856965821&account_number=9405940+3845039+930405&message=Hello+world&latlong=-39.236474%2C+175.560343&page_source=http%3A%2F%2Fwww.synthetix.com&trigger=home_page×lot=timeslot&source_device=&subject=Website+contact&attachments="

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/queue/entity", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/queue/entity");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "token=97B25C61-19FF-XXXX-3824-CAA8D691B010&channel=0&brand=Argos&firstname=Gary&surname=McKenzie&skill=Accounts&email=gary_mckenzie%40gmail.com&phone=7856965821&account_number=9405940+3845039+930405&message=Hello+world&latlong=-39.236474%2C+175.560343&page_source=http%3A%2F%2Fwww.synthetix.com&trigger=home_page×lot=timeslot&source_device=&subject=Website+contact&attachments=");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/queue/entity");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "token=97B25C61-19FF-XXXX-3824-CAA8D691B010&channel=0&brand=Argos&firstname=Gary&surname=McKenzie&skill=Accounts&email=gary_mckenzie%40gmail.com&phone=7856965821&account_number=9405940+3845039+930405&message=Hello+world&latlong=-39.236474%2C+175.560343&page_source=http%3A%2F%2Fwww.synthetix.com&trigger=home_page×lot=timeslot&source_device=&subject=Website+contact&attachments=", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/queue/entity")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("token=97B25C61-19FF-XXXX-3824-CAA8D691B010&channel=0&brand=Argos&firstname=Gary&surname=McKenzie&skill=Accounts&email=gary_mckenzie%40gmail.com&phone=7856965821&account_number=9405940+3845039+930405&message=Hello+world&latlong=-39.236474%2C+175.560343&page_source=http%3A%2F%2Fwww.synthetix.com&trigger=home_page×lot=timeslot&source_device=&subject=Website+contact&attachments=")
      .asString();

	
	

queue/entity

PATCH

https://api.syn-finity.com/1.1/queue/entity

Example API Request

Resource information

This resource allows either the brand, the operator, the skill or the type for an existing contact to be amended in the Queue system. It also enables transfers of contacts between users, changing participants in a given contact. Please note, as skills and types have to be cross referenced, if both are to be changed, this should be done using two calls.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • type

    integer

    Optional

    The NEW type of contact 0 => 'Live chat', 1 => 'Callback', 2 => 'Email', 3 => 'VOIP', 4 => 'Video', 5 => 'WhatsApp', 6 => 'Skype IM', 7 => 'SMS', 8 => 'Twitter', 9 => 'Ticket',

    Example 0

  • token

    string

    Required

    The ID for the current session

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • uniQref

    string

    Required

    Reference for particular entity being amended.

    Example kld893jktogJ

  • brand

    string

    Optional

    The NEW brand to be assigned to the contact.

    Example Argos

  • skill

    string

    Optional

    The NEW skill to be assigned to the contact.

    Example Accounts

  • op_id

    integer

    Optional

    The ID of the NEW operator

    Example 1974

  • leave

    bool

    Optional

    If an operator ID is included, indicates that operator is leaving the contact. If not passed in, defaults to false

    Example true

  • invite

    bool

    Optional

    If an operator ID is included, indicates that operator is being invited to join the contact. If not passed in, defaults to false

    Example true

  • feedback

    string

    Optional

    Allows the agent to recategorise or provide feedback on the chat.

    Example Yes

  • timeframe

    string

    Optional

    New timeframe for callbacks.

    Example

Example Request

{
  "channel":1,
  "brand":"Synthetix"
}

Example Response

{
  "updated":"true"
}

Expected Errors

  • Error Code

    Summary

  • 186

    CANNOT REMOVE OWNER

  • 149

    INVALID SKILL

  • 184

    TRANSFER NOT AVAILABLE

  • 146

    INVALID CHANNEL

  • 139

  • 147

    VOID ID

  • 171

    CANNOT CHANGE EXISTING EMAIL

  • 187

    INVALID PARTICIPANT

HTTP Example

	
    PATCH /1.1/queue/entity HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    type=0&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=kld893jktogJ&brand=Argos&skill=Accounts&op_id=1974&leave=true&invite=true&feedback=Yes&timeframe=
	
	

CURL Example

	
    curl --request PATCH
    --url "https://api.syn-finity.com/1.1/queue/entity?type=0&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=kld893jktogJ&brand=Argos&skill=Accounts&op_id=1974&leave=true&invite=true&feedback=Yes&timeframe="
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/queue/entity?type=0&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=kld893jktogJ&brand=Argos&skill=Accounts&op_id=1974&leave=true&invite=true&feedback=Yes&timeframe=",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "PATCH",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"PATCH",
        url:"https://api.syn-finity.com/1.1/queue/entity",
        dataType:"json",
        crossDomain:true,
        data:"type=0&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=kld893jktogJ&brand=Argos&skill=Accounts&op_id=1974&leave=true&invite=true&feedback=Yes&timeframe=",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "type=0&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=kld893jktogJ&brand=Argos&skill=Accounts&op_id=1974&leave=true&invite=true&feedback=Yes&timeframe="

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("PATCH", "/1.1/queue/entity", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/queue/entity");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "type=0&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=kld893jktogJ&brand=Argos&skill=Accounts&op_id=1974&leave=true&invite=true&feedback=Yes&timeframe=");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/queue/entity");
    var request = new RestRequest(Method.PATCH);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "type=0&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=kld893jktogJ&brand=Argos&skill=Accounts&op_id=1974&leave=true&invite=true&feedback=Yes&timeframe=", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.PATCH("https://api.syn-finity.com/1.1/queue/entity")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("type=0&token=97B25C61-19FF-XXXX-3824-CAA8D691B010&uniQref=kld893jktogJ&brand=Argos&skill=Accounts&op_id=1974&leave=true&invite=true&feedback=Yes&timeframe=")
      .asString();

	
	

queue/feedback

POST

https://api.syn-finity.com/1.1/queue/feedback

Example API Request

Resource information

DEPRECATED in favour of livechat/feedback. Allows the customer’s answers to feedback questions to be stored against their contact. If a multiple choice answer is required, the answers must match one of the multiple choices offered against the question ID. If full text answers are indicated, any textual answer will be accepted.

  • Authentication

    True

  • Quota Controlled

    True

  • Rate Limited

    NA

What's new

View All

Header parameters

{
  "APPLICATIONKEY":"YOUR API APPLICATIONKEY KEY HERE",
  "CONSUMERKEY":"YOUR API CONSUMERKEY KEY HERE"
}

Query parameters

  • Parameter

    Description

  • session

    string

    Required

    The ID for your current session

    Example 97B25C61-19FF-XXXX-3824-CAA8D691B010

  • q1

    string

    Required

    The feedback against Q1.

    Example Yes

  • q2

    string

    Optional

    The feedback against Q2.

    Example Great

  • q3

    string

    Optional

    The feedback against Q3.

    Example No

  • q4

    string

    Optional

    The feedback against Q4.

    Example Could have been slightly less efficient

  • q5

    string

    Optional

    The feedback against Q5.

    Example Yes

Example Request

{
  "session":"97B25C61-19FF-XXXX-3824-CAA8D691B010",
  "q1":"Yes",
  "q2":"Great",
  "q3":"No",
  "q4":"Very helpful",
  "q5":"Yes"
}

Example Response

{
  "feedback_successful":true
}

Expected Errors

  • Error Code

    Summary

  • 106

    MISSING PARAMETER

  • 144

    CANNOT CONNECT

HTTP Example

	
    POST /1.1/queue/feedback HTTP/1.1
    Host: api.syn-finity.com
    APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2
    CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744
    Cache-Control: no-cache
    Content-Type: application/x-www-form-urlencoded

    session=97B25C61-19FF-XXXX-3824-CAA8D691B010&q1=Yes&q2=Great&q3=No&q4=Could+have+been+slightly+less+efficient&q5=Yes
	
	

CURL Example

	
    curl --request POST
    --url "https://api.syn-finity.com/1.1/queue/feedback?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&q1=Yes&q2=Great&q3=No&q4=Could+have+been+slightly+less+efficient&q5=Yes"
    --header "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2"
    --header "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744"

PHP Example

	
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => "https://api.syn-finity.com/1.1/queue/feedback?session=97B25C61-19FF-XXXX-3824-CAA8D691B010&q1=Yes&q2=Great&q3=No&q4=Could+have+been+slightly+less+efficient&q5=Yes",
        CURLOPT_VERBOSE => true,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "",
        CURLOPT_HTTPHEADER => array("APPLICATIONKEY:e25eb672ad27103bXXXXb92d5d9b1ca2", "CONSUMERKEY:4b2ab36868b65XXXX15d0e7c38fdf744")
    ));
    $Response = curl_exec ($curl);
	
	

AJAX Example

	
    $.ajax({
        type:"POST",
        url:"https://api.syn-finity.com/1.1/queue/feedback",
        dataType:"json",
        crossDomain:true,
        data:"session=97B25C61-19FF-XXXX-3824-CAA8D691B010&q1=Yes&q2=Great&q3=No&q4=Could+have+been+slightly+less+efficient&q5=Yes",
        headers:{
            "APPLICATIONKEY":e25eb672ad27103bXXXXb92d5d9b1ca2,
            "CONSUMERKEY":4b2ab36868b65XXXX15d0e7c38fdf744
       },
        success:function(data){
            console.log(response);
        },
        error:function(data){
            console.log(response);
        },
    });
	
	

PYTHON Example

	
    import http.client

    conn = http.client.HTTPSConnection("api.syn-finity.com")

    payload = "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&q1=Yes&q2=Great&q3=No&q4=Could+have+been+slightly+less+efficient&q5=Yes"

    headers = {
        "applicationkey": "e25eb672ad27103bXXXXb92d5d9b1ca2",
        "consumerkey": "4b2ab36868b65XXXX15d0e7c38fdf744",
        "cache-control": "no-cache",
        "content-type": "application/x-www-form-urlencoded"
        }

    conn.request("POST", "/1.1/queue/feedback", payload, headers)

    res = conn.getresponse()
    data = res.read()

    print(data.decode("utf-8"))
	
	

C Example

	

    CURL *hnd = curl_easy_init();

    curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
    curl_easy_setopt(hnd, CURLOPT_URL, "https://api.syn-finity.com/1.1/queue/feedback");

    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "content-type: application/x-www-form-urlencoded");
    headers = curl_slist_append(headers, "cache-control: no-cache");
    headers = curl_slist_append(headers, "CONSUMERKEY: 4b2ab36868b65XXXX15d0e7c38fdf744");
    headers = curl_slist_append(headers, "APPLICATIONKEY: e25eb672ad27103bXXXXb92d5d9b1ca2");
    curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

    curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&q1=Yes&q2=Great&q3=No&q4=Could+have+been+slightly+less+efficient&q5=Yes");

    CURLcode ret = curl_easy_perform(hnd);

	
	

C# Example

	

    var client = new RestClient("https://api.syn-finity.com/1.1/queue/feedback");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/x-www-form-urlencoded");
    request.AddHeader("cache-control", "no-cache");
    request.AddHeader("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744");
    request.AddHeader("APPLICATIONKEY", "e25eb672ad27103bXXXXb92d5d9b1ca2");
    request.AddParameter("application/x-www-form-urlencoded", "session=97B25C61-19FF-XXXX-3824-CAA8D691B010&q1=Yes&q2=Great&q3=No&q4=Could+have+been+slightly+less+efficient&q5=Yes", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

	
	

JAVA Unirest Example

	

    HttpResponse response = Unirest.POST("https://api.syn-finity.com/1.1/queue/feedback")
      .header("applicationkey", "e25eb672ad27103bXXXXb92d5d9b1ca2")
      .header("CONSUMERKEY", "4b2ab36868b65XXXX15d0e7c38fdf744")
      .header("cache-control", "no-cache")
      .header("content-type", "application/x-www-form-urlencoded")
      .body("session=97B25C61-19FF-XXXX-3824-CAA8D691B010&q1=Yes&q2=Great&q3=No&q4=Could+have+been+slightly+less+efficient&q5=Yes")
      .asString();