NAV Navbar
Shell HTTP JavaScript Node.JS Ruby Python Java
  • botsplash api v0.0.1
  • Authentication
  • Campaigns
  • Visitors
  • Messages
  • Agents
  • Healthcheck
  • Schemas
  • botsplash api v0.0.1

    Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

    Welcome to the botsplash.com API!

    You can use this API to access botsplash.com API endpoints, which will allow to submit Inbound API requests and access.

    We have language bindings in Shell, Python and Javascript! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

    If you need examples in different programming language or help assisting with integrations, write to us at [email protected]

    Base URLs:

    Authentication

    Currently, the API is available for selected customers. If you need the access to the API, email to us at [email protected].

    Campaigns

    Initiate inbound campaigns

    Campaign List

    Code samples

    # You can also use wget
    curl -X GET https://api.botsplash.com/open/v1/{appId}/campaign \
      -H 'Accept: application/json'
    
    
    
    GET https://api.botsplash.com/open/v1/{appId}/campaign HTTP/1.1
    Host: null
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.botsplash.com/open/v1/{appId}/campaign',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.botsplash.com/open/v1/{appId}/campaign',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.botsplash.com/open/v1/{appId}/campaign',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.botsplash.com/open/v1/{appId}/campaign', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.botsplash.com/open/v1/{appId}/campaign");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /{appId}/campaign

    Returns active 'Campaign's to the caller

    Parameters

    Parameter In Type Required Description
    appId path string(uuid) true No description

    Example responses

    {
      "count": 0,
      "items": [
        {
          "id": "string",
          "title": "string",
          "channelId": "string",
          "channelName": "string",
          "channelTypeId": 0,
          "createdAt": "2018-01-17T00:42:13Z",
          "updatedAt": "2018-01-17T00:42:13Z"
        }
      ]
    }
    
    {
      "message": "string"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success CampaignListResponse
    default Default Error ErrorResponse

    Visitor Campaign Request

    Code samples

    # You can also use wget
    curl -X POST https://api.botsplash.com/open/v1/{appId}/campaign/{id}/request \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json'
    
    
    
    POST https://api.botsplash.com/open/v1/{appId}/campaign/{id}/request HTTP/1.1
    Host: null
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.botsplash.com/open/v1/{appId}/campaign/{id}/request',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "visitor": {
        "id": "string",
        "clientVisitorId": "string",
        "agentId": "string",
        "agentClientUserId": "string",
        "teamId": "string",
        "teamCode": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phoneNumber": "string",
        "state": "string",
        "unsubscribe": 0
      }
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.botsplash.com/open/v1/{appId}/campaign/{id}/request',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.botsplash.com/open/v1/{appId}/campaign/{id}/request',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.botsplash.com/open/v1/{appId}/campaign/{id}/request', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.botsplash.com/open/v1/{appId}/campaign/{id}/request");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /{appId}/campaign/{id}/request

    Start visitor campaign request using internal flow

    Body parameter

    {
      "visitor": {
        "id": "string",
        "clientVisitorId": "string",
        "agentId": "string",
        "agentClientUserId": "string",
        "teamId": "string",
        "teamCode": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phoneNumber": "string",
        "state": "string",
        "unsubscribe": 0
      }
    }
    

    Parameters

    Parameter In Type Required Description
    body body object true Campaign request body
    appId path string(uuid) true No description
    id path string true No description

    Example responses

    {
      "success": true,
      "requestId": "string",
      "messageId": "string"
    }
    
    {
      "message": "string"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success CampaignRequestResponse
    default Default Error ErrorResponse

    Visitors

    Visitors listing and updates to agent assignment

    Visitors List

    Code samples

    # You can also use wget
    curl -X GET https://api.botsplash.com/open/v1/{appId}/visitor \
      -H 'Accept: application/json'
    
    
    
    GET https://api.botsplash.com/open/v1/{appId}/visitor HTTP/1.1
    Host: null
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.botsplash.com/open/v1/{appId}/visitor',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.botsplash.com/open/v1/{appId}/visitor',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.botsplash.com/open/v1/{appId}/visitor',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.botsplash.com/open/v1/{appId}/visitor', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.botsplash.com/open/v1/{appId}/visitor");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /{appId}/visitor

    Returns paged visitors list of 'Visitors' to the caller

    Parameters

    Parameter In Type Required Description
    limit query integer false No description
    skip query integer false No description
    appId path string(uuid) true No description

    Example responses

    {
      "count": 0,
      "items": [
        {
          "id": "string",
          "clientVisitorId": "string",
          "handle": "string",
          "agentId": "string",
          "agentClientUserId": "string",
          "teamId": "string",
          "teamCode": "string",
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phoneNumber": "string",
          "pictureUrl": "string",
          "city": "string",
          "state": "string",
          "archived": true,
          "bookmarked": true,
          "unsubscribe": 0
        }
      ]
    }
    
    {
      "message": "string"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success VisitorListResponse
    default Default Error ErrorResponse

    Get Visitor

    Code samples

    # You can also use wget
    curl -X GET https://api.botsplash.com/open/v1/{appId}/visitor/{num} \
      -H 'Accept: application/json'
    
    
    
    GET https://api.botsplash.com/open/v1/{appId}/visitor/{num} HTTP/1.1
    Host: null
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.botsplash.com/open/v1/{appId}/visitor/{num}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.botsplash.com/open/v1/{appId}/visitor/{num}',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.botsplash.com/open/v1/{appId}/visitor/{num}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.botsplash.com/open/v1/{appId}/visitor/{num}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.botsplash.com/open/v1/{appId}/visitor/{num}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /{appId}/visitor/{num}

    Returns 'Visitor' to the caller

    Parameters

    Parameter In Type Required Description
    appId path string(uuid) true No description
    num path number true No description

    Example responses

    {
      "id": "string",
      "clientVisitorId": "string",
      "handle": "string",
      "agentId": "string",
      "agentClientUserId": "string",
      "teamId": "string",
      "teamCode": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "pictureUrl": "string",
      "city": "string",
      "state": "string",
      "archived": true,
      "bookmarked": true,
      "unsubscribe": 0
    }
    
    {
      "message": "string"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success Visitor
    default Default Error ErrorResponse

    Update Visitor

    Code samples

    # You can also use wget
    curl -X PUT https://api.botsplash.com/open/v1/{appId}/visitor/{num} \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json'
    
    
    
    PUT https://api.botsplash.com/open/v1/{appId}/visitor/{num} HTTP/1.1
    Host: null
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.botsplash.com/open/v1/{appId}/visitor/{num}',
      method: 'put',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "id": "string",
      "clientVisitorId": "string",
      "agentId": "string",
      "agentClientUserId": "string",
      "teamId": "string",
      "teamCode": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "state": "string",
      "unsubscribe": 0
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.botsplash.com/open/v1/{appId}/visitor/{num}',
    {
      method: 'PUT',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.put 'https://api.botsplash.com/open/v1/{appId}/visitor/{num}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.put('https://api.botsplash.com/open/v1/{appId}/visitor/{num}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.botsplash.com/open/v1/{appId}/visitor/{num}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("PUT");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    PUT /{appId}/visitor/{num}

    Update Visitor information including Agent Assignment

    Body parameter

    {
      "id": "string",
      "clientVisitorId": "string",
      "agentId": "string",
      "agentClientUserId": "string",
      "teamId": "string",
      "teamCode": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "state": "string",
      "unsubscribe": 0
    }
    

    Parameters

    Parameter In Type Required Description
    body body VisitorSubmit true Visitor submit body
    appId path string(uuid) true No description
    num path number true No description

    Example responses

    {
      "id": "string",
      "clientVisitorId": "string",
      "handle": "string",
      "agentId": "string",
      "agentClientUserId": "string",
      "teamId": "string",
      "teamCode": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "pictureUrl": "string",
      "city": "string",
      "state": "string",
      "archived": true,
      "bookmarked": true,
      "unsubscribe": 0
    }
    
    {
      "message": "string"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success Visitor
    default Default Error ErrorResponse

    Get Visitor By Client User ID

    Code samples

    # You can also use wget
    curl -X GET https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId} \
      -H 'Accept: application/json'
    
    
    
    GET https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId} HTTP/1.1
    Host: null
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /{appId}/visitor/clientVisitorId/{clientVisitorId}

    Returns 'Visitor' to the caller

    Parameters

    Parameter In Type Required Description
    appId path string(uuid) true No description
    clientVisitorId path string true No description

    Example responses

    {
      "id": "string",
      "clientVisitorId": "string",
      "handle": "string",
      "agentId": "string",
      "agentClientUserId": "string",
      "teamId": "string",
      "teamCode": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "pictureUrl": "string",
      "city": "string",
      "state": "string",
      "archived": true,
      "bookmarked": true,
      "unsubscribe": 0
    }
    
    {
      "message": "string"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success Visitor
    default Default Error ErrorResponse

    Update Visitor By Client User ID

    Code samples

    # You can also use wget
    curl -X PUT https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId} \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json'
    
    
    
    PUT https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId} HTTP/1.1
    Host: null
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}',
      method: 'put',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "id": "string",
      "clientVisitorId": "string",
      "agentId": "string",
      "agentClientUserId": "string",
      "teamId": "string",
      "teamCode": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "state": "string",
      "unsubscribe": 0
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}',
    {
      method: 'PUT',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.put 'https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.put('https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("PUT");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    PUT /{appId}/visitor/clientVisitorId/{clientVisitorId}

    Update Visitor information including Agent Assignment using Client User ID

    Body parameter

    {
      "id": "string",
      "clientVisitorId": "string",
      "agentId": "string",
      "agentClientUserId": "string",
      "teamId": "string",
      "teamCode": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "state": "string",
      "unsubscribe": 0
    }
    

    Parameters

    Parameter In Type Required Description
    body body VisitorSubmit true Visitor submit body
    appId path string(uuid) true No description
    clientVisitorId path string true No description

    Example responses

    {
      "id": "string",
      "clientVisitorId": "string",
      "handle": "string",
      "agentId": "string",
      "agentClientUserId": "string",
      "teamId": "string",
      "teamCode": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "pictureUrl": "string",
      "city": "string",
      "state": "string",
      "archived": true,
      "bookmarked": true,
      "unsubscribe": 0
    }
    
    {
      "message": "string"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success Visitor
    default Default Error ErrorResponse

    Messages

    Visitor Chat Messages

    Get Visitor Messages

    Code samples

    # You can also use wget
    curl -X GET https://api.botsplash.com/open/v1/{appId}/visitor/{num}/message \
      -H 'Accept: application/json'
    
    
    
    GET https://api.botsplash.com/open/v1/{appId}/visitor/{num}/message HTTP/1.1
    Host: null
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.botsplash.com/open/v1/{appId}/visitor/{num}/message',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.botsplash.com/open/v1/{appId}/visitor/{num}/message',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.botsplash.com/open/v1/{appId}/visitor/{num}/message',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.botsplash.com/open/v1/{appId}/visitor/{num}/message', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.botsplash.com/open/v1/{appId}/visitor/{num}/message");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /{appId}/visitor/{num}/message

    Returns 'Visitor' to the caller

    Parameters

    Parameter In Type Required Description
    limit query integer false No description
    skip query integer false No description
    appId path string(uuid) true No description
    num path number true No description

    Example responses

    {
      "success": true,
      "requestId": "string",
      "messageId": "string"
    }
    
    {
      "message": "string"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success CampaignRequestResponse
    default Default Error ErrorResponse

    Send Visitor Message

    Code samples

    # You can also use wget
    curl -X POST https://api.botsplash.com/open/v1/{appId}/visitor/{num}/message \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json'
    
    
    
    POST https://api.botsplash.com/open/v1/{appId}/visitor/{num}/message HTTP/1.1
    Host: null
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.botsplash.com/open/v1/{appId}/visitor/{num}/message',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "text": "string",
      "visitor": {
        "id": "string",
        "clientVisitorId": "string",
        "agentId": "string",
        "agentClientUserId": "string",
        "teamId": "string",
        "teamCode": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phoneNumber": "string",
        "state": "string",
        "unsubscribe": 0
      }
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.botsplash.com/open/v1/{appId}/visitor/{num}/message',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.botsplash.com/open/v1/{appId}/visitor/{num}/message',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.botsplash.com/open/v1/{appId}/visitor/{num}/message', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.botsplash.com/open/v1/{appId}/visitor/{num}/message");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /{appId}/visitor/{num}/message

    Send direct message to user

    Body parameter

    {
      "text": "string",
      "visitor": {
        "id": "string",
        "clientVisitorId": "string",
        "agentId": "string",
        "agentClientUserId": "string",
        "teamId": "string",
        "teamCode": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phoneNumber": "string",
        "state": "string",
        "unsubscribe": 0
      }
    }
    

    Parameters

    Parameter In Type Required Description
    body body Body true Campaign request body
    appId path string(uuid) true No description
    num path number true No description

    Example responses

    {
      "id": "string",
      "clientVisitorId": "string",
      "handle": "string",
      "agentId": "string",
      "agentClientUserId": "string",
      "teamId": "string",
      "teamCode": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "pictureUrl": "string",
      "city": "string",
      "state": "string",
      "archived": true,
      "bookmarked": true,
      "unsubscribe": 0
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success Visitor

    Get Visitor Messages By Client User Id

    Code samples

    # You can also use wget
    curl -X GET https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}/message \
      -H 'Accept: application/json'
    
    
    
    GET https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}/message HTTP/1.1
    Host: null
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}/message',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}/message',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}/message',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}/message', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}/message");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /{appId}/visitor/clientVisitorId/{clientVisitorId}/message

    Returns Visitor Chat Messages from the dashboard

    Parameters

    Parameter In Type Required Description
    limit query integer false No description
    skip query integer false No description
    appId path string(uuid) true No description
    clientVisitorId path string true No description

    Example responses

    {
      "success": true,
      "requestId": "string",
      "messageId": "string"
    }
    
    {
      "message": "string"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success CampaignRequestResponse
    default Default Error ErrorResponse

    Send Visitor Message By Client User Id

    Code samples

    # You can also use wget
    curl -X POST https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}/message \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json'
    
    
    
    POST https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}/message HTTP/1.1
    Host: null
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}/message',
      method: 'post',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "text": "string",
      "visitor": {
        "id": "string",
        "clientVisitorId": "string",
        "agentId": "string",
        "agentClientUserId": "string",
        "teamId": "string",
        "teamCode": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phoneNumber": "string",
        "state": "string",
        "unsubscribe": 0
      }
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}/message',
    {
      method: 'POST',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.post 'https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}/message',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.post('https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}/message', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.botsplash.com/open/v1/{appId}/visitor/clientVisitorId/{clientVisitorId}/message");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("POST");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    POST /{appId}/visitor/clientVisitorId/{clientVisitorId}/message

    Sends SMS or Facebook message using Client User Id

    Body parameter

    {
      "text": "string",
      "visitor": {
        "id": "string",
        "clientVisitorId": "string",
        "agentId": "string",
        "agentClientUserId": "string",
        "teamId": "string",
        "teamCode": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phoneNumber": "string",
        "state": "string",
        "unsubscribe": 0
      }
    }
    

    Parameters

    Parameter In Type Required Description
    body body Body true Campaign request body
    appId path string(uuid) true No description
    clientVisitorId path string true No description

    Example responses

    {
      "id": "string",
      "clientVisitorId": "string",
      "handle": "string",
      "agentId": "string",
      "agentClientUserId": "string",
      "teamId": "string",
      "teamCode": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "pictureUrl": "string",
      "city": "string",
      "state": "string",
      "archived": true,
      "bookmarked": true,
      "unsubscribe": 0
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success Visitor

    Agents

    Agents listing and managing access status

    Update Agent Status

    Code samples

    # You can also use wget
    curl -X PUT https://api.botsplash.com/open/v1/{appId}/agent/{id} \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json'
    
    
    
    PUT https://api.botsplash.com/open/v1/{appId}/agent/{id} HTTP/1.1
    Host: null
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.botsplash.com/open/v1/{appId}/agent/{id}',
      method: 'put',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "status": 0
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.botsplash.com/open/v1/{appId}/agent/{id}',
    {
      method: 'PUT',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.put 'https://api.botsplash.com/open/v1/{appId}/agent/{id}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.put('https://api.botsplash.com/open/v1/{appId}/agent/{id}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.botsplash.com/open/v1/{appId}/agent/{id}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("PUT");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    PUT /{appId}/agent/{id}

    Update Agent detail

    Body parameter

    {
      "status": 0
    }
    

    Parameters

    Parameter In Type Required Description
    body body AgentEdit true No description
    appId path string(uuid) true No description
    id path string true No description

    Example responses

    {
      "id": 0,
      "clientVisitorId": 0,
      "status": 0,
      "firstName": "string",
      "lastName": 0,
      "email": 0,
      "primaryPhone": 0
    }
    

    Responses

    Status Meaning Description Schema
    200 OK successful edit AgentRead

    Update Agent by Client User Id

    Code samples

    # You can also use wget
    curl -X PUT https://api.botsplash.com/open/v1/{appId}/agent/clientUserId/{clientUserId} \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json'
    
    
    
    PUT https://api.botsplash.com/open/v1/{appId}/agent/clientUserId/{clientUserId} HTTP/1.1
    Host: null
    Content-Type: application/json
    Accept: application/json
    
    
    
    var headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.botsplash.com/open/v1/{appId}/agent/clientUserId/{clientUserId}',
      method: 'put',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    const inputBody = '{
      "status": 0
    }';
    const headers = {
      'Content-Type':'application/json',
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.botsplash.com/open/v1/{appId}/agent/clientUserId/{clientUserId}',
    {
      method: 'PUT',
      body: inputBody,
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Content-Type' => 'application/json',
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.put 'https://api.botsplash.com/open/v1/{appId}/agent/clientUserId/{clientUserId}',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Content-Type': 'application/json',
      'Accept': 'application/json'
    }
    
    
    r = requests.put('https://api.botsplash.com/open/v1/{appId}/agent/clientUserId/{clientUserId}', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.botsplash.com/open/v1/{appId}/agent/clientUserId/{clientUserId}");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("PUT");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    PUT /{appId}/agent/clientUserId/{clientUserId}

    Update Agent details using Client User Id

    Body parameter

    {
      "status": 0
    }
    

    Parameters

    Parameter In Type Required Description
    body body AgentEdit true No description
    appId path string(uuid) true No description
    clientUserId path string true No description

    Example responses

    {
      "id": 0,
      "clientVisitorId": 0,
      "status": 0,
      "firstName": "string",
      "lastName": 0,
      "email": 0,
      "primaryPhone": 0
    }
    

    Responses

    Status Meaning Description Schema
    200 OK successful edit AgentRead

    Healthcheck

    Health check for API

    Ping

    Code samples

    # You can also use wget
    curl -X GET https://api.botsplash.com/open/v1/{appId}/ping \
      -H 'Accept: application/json'
    
    
    
    GET https://api.botsplash.com/open/v1/{appId}/ping HTTP/1.1
    Host: null
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.botsplash.com/open/v1/{appId}/ping',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.botsplash.com/open/v1/{appId}/ping',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.botsplash.com/open/v1/{appId}/ping',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.botsplash.com/open/v1/{appId}/ping', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.botsplash.com/open/v1/{appId}/ping");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /{appId}/ping

    Returns 'pong' message. This message is to ensure that the API service is up and running.

    Parameters

    Parameter In Type Required Description
    appId path string(uuid) true No description

    Example responses

    "string"
    
    {
      "message": "string"
    }
    

    Responses

    Status Meaning Description Schema
    200 OK Success string
    default Default Error ErrorResponse

    Healthcheck

    Code samples

    # You can also use wget
    curl -X GET https://api.botsplash.com/open/v1/healthcheck \
      -H 'Accept: application/json'
    
    
    
    GET https://api.botsplash.com/open/v1/healthcheck HTTP/1.1
    Host: null
    
    
    Accept: application/json
    
    
    
    var headers = {
      'Accept':'application/json'
    
    
    };
    
    
    $.ajax({
      url: 'https://api.botsplash.com/open/v1/healthcheck',
      method: 'get',
    
    
      headers: headers,
      success: function(data) {
        console.log(JSON.stringify(data));
      }
    })
    
    
    
    const request = require('node-fetch');
    
    
    const headers = {
      'Accept':'application/json'
    
    
    };
    
    
    fetch('https://api.botsplash.com/open/v1/healthcheck',
    {
      method: 'GET',
    
    
      headers: headers
    })
    .then(function(res) {
        return res.json();
    }).then(function(body) {
        console.log(body);
    });
    
    
    
    require 'rest-client'
    require 'json'
    
    
    headers = {
      'Accept' => 'application/json'
    }
    
    
    result = RestClient.get 'https://api.botsplash.com/open/v1/healthcheck',
      params: {
      }, headers: headers
    
    
    p JSON.parse(result)
    
    
    
    import requests
    headers = {
      'Accept': 'application/json'
    }
    
    
    r = requests.get('https://api.botsplash.com/open/v1/healthcheck', params={
    
    
    }, headers = headers)
    
    
    print r.json()
    
    
    
    URL obj = new URL("https://api.botsplash.com/open/v1/healthcheck");
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    con.setRequestMethod("GET");
    int responseCode = con.getResponseCode();
    BufferedReader in = new BufferedReader(
        new InputStreamReader(con.getInputStream()));
    String inputLine;
    StringBuffer response = new StringBuffer();
    while ((inputLine = in.readLine()) != null) {
        response.append(inputLine);
    }
    in.close();
    System.out.println(response.toString());
    
    
    

    GET /healthcheck

    Example responses

    {
      "success": true
    }
    

    Responses

    Status Meaning Description Schema
    200 OK successful response HealthSuccess

    Schemas

    Campaign

    {
      "id": "string",
      "title": "string",
      "channelId": "string",
      "channelName": "string",
      "channelTypeId": 0,
      "createdAt": "2018-01-17T00:42:13Z",
      "updatedAt": "2018-01-17T00:42:13Z"
    }
    

    Properties

    Name Type Required Description
    id string true CampaignID
    title string true Name of the campaign
    channelId string(uuid) true Channel to execute campaign
    channelName string false Name of Channel to execute campaign
    channelTypeId number true Channel Type (1 - Facebook, 2 - Slack, 6 - SMS, 8 - Email)
    createdAt string(date-time) false Campaign created date time
    updatedAt string(date-time) false Campaign updated date time

    CampaignList

    [
      {
        "id": "string",
        "title": "string",
        "channelId": "string",
        "channelName": "string",
        "channelTypeId": 0,
        "createdAt": "2018-01-17T00:42:13Z",
        "updatedAt": "2018-01-17T00:42:13Z"
      }
    ]
    

    Properties

    Name Type Required Description
    anonymous [Campaign] false No description

    CampaignListResponse

    {
      "count": 0,
      "items": [
        {
          "id": "string",
          "title": "string",
          "channelId": "string",
          "channelName": "string",
          "channelTypeId": 0,
          "createdAt": "2018-01-17T00:42:13Z",
          "updatedAt": "2018-01-17T00:42:13Z"
        }
      ]
    }
    

    Properties

    Name Type Required Description
    count number true No description
    items CampaignList true No description

    CampaignRequestResponse

    {
      "success": true,
      "requestId": "string",
      "messageId": "string"
    }
    

    Properties

    Name Type Required Description
    success boolean true No description
    requestId string(uuid) true request message id
    messageId string(uuid) true request message id

    Visitor

    {
      "id": "string",
      "clientVisitorId": "string",
      "handle": "string",
      "agentId": "string",
      "agentClientUserId": "string",
      "teamId": "string",
      "teamCode": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "pictureUrl": "string",
      "city": "string",
      "state": "string",
      "archived": true,
      "bookmarked": true,
      "unsubscribe": 0
    }
    

    Properties

    Name Type Required Description
    id string(number) true No description
    clientVisitorId string false No description
    handle string false No description
    agentId string(number) false No description
    agentClientUserId string false No description
    teamId string(uuid) false No description
    teamCode string false No description
    firstName string false No description
    lastName string false No description
    email string false No description
    phoneNumber string false No description
    pictureUrl string false No description
    city string false No description
    state string false No description
    archived boolean false No description
    bookmarked boolean false No description
    unsubscribe number true No description

    VisitorSubmit

    {
      "id": "string",
      "clientVisitorId": "string",
      "agentId": "string",
      "agentClientUserId": "string",
      "teamId": "string",
      "teamCode": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "state": "string",
      "unsubscribe": 0
    }
    

    Properties

    Name Type Required Description
    id string(number) false No description
    clientVisitorId string false No description
    agentId string(number) false No description
    agentClientUserId string false No description
    teamId string(uuid) false No description
    teamCode string false No description
    firstName string false No description
    lastName string false No description
    email string false No description
    phoneNumber string true No description
    state string false No description
    unsubscribe number false No description

    VisitorList

    [
      {
        "id": "string",
        "clientVisitorId": "string",
        "handle": "string",
        "agentId": "string",
        "agentClientUserId": "string",
        "teamId": "string",
        "teamCode": "string",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phoneNumber": "string",
        "pictureUrl": "string",
        "city": "string",
        "state": "string",
        "archived": true,
        "bookmarked": true,
        "unsubscribe": 0
      }
    ]
    

    Properties

    Name Type Required Description
    anonymous [Visitor] false No description

    VisitorListResponse

    {
      "count": 0,
      "items": [
        {
          "id": "string",
          "clientVisitorId": "string",
          "handle": "string",
          "agentId": "string",
          "agentClientUserId": "string",
          "teamId": "string",
          "teamCode": "string",
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phoneNumber": "string",
          "pictureUrl": "string",
          "city": "string",
          "state": "string",
          "archived": true,
          "bookmarked": true,
          "unsubscribe": 0
        }
      ]
    }
    

    Properties

    Name Type Required Description
    count number true No description
    items VisitorList true No description

    AgentRead

    {
      "id": 0,
      "clientVisitorId": 0,
      "status": 0,
      "firstName": "string",
      "lastName": 0,
      "email": 0,
      "primaryPhone": 0
    }
    

    Properties

    Name Type Required Description
    id number false No description
    clientVisitorId number false No description
    status number false No description
    firstName string false No description
    lastName number false No description
    email number false No description
    primaryPhone number false No description

    AgentEdit

    {
      "status": 0
    }
    

    Properties

    Name Type Required Description
    status number false No description

    ErrorResponse

    {
      "message": "string"
    }
    

    Properties

    Name Type Required Description
    message string true No description

    HealthSuccess

    {
      "success": true
    }
    

    Properties

    Name Type Required Description
    success boolean true No description