Example Client APIs - Customer Support APIs

Customer Support APIs

Click an API to expand/collapse it.

Attribute	Type	Use	Description
`uuid`	String	Required	The user UUID.
`udid`	String	Required	The device UDID.
`subject`	String	Required	The customer support subject.
`message`	String	Required	The customer support message.
`email`	String	Required	Customer email, where they need communication. This mail id may not be registered for the user.
`name`	String	Optional	The customer's name.
`category`	String	Required	The support category.
`phone`	String	OPtional	The customer's phone, where they need communication. This phone may not be registered for the user, and the user has to provide the correct format.
`images`	Array	Optional	Image names uploaded through a common upload file service (common/upload/file?bucketType=LOG_IMAGE) with bucketType = LOG_IMAGE. These image AWS links will be added to the ZenDesk ticket message body.

GETDownload Customer Support File

Description

Downloads a log or feed back photo depending on the parameter "LOG" or "FEEDBACK_PHOTO" respectively.

Request Endpoint

GET https://<Example api server address>/aws/download/support/file/{coreTicketId}/{HelpSupportFileType}

Parameters

Parameter Type Use Description

coreTicketId String Required The Client ticket id.

HelpSupportFileType String Required The LOG or FEEDBACK_PHOTO.

If LOG is passed, it will be considered as a log file.

if FEEDBACK_PHOTO is passed, it will be considered as a feedback photo.

cURL syntax
curl --include \
'https://core.dev.Example.net/api/aws/download/support/file/coreTicketId/HelpSupportFileType'
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
LOG or FEEDBACK_PHOTO file
Return to top

Parameter	Type	Use	Description
coreTicketId	String	Required	The Client ticket id.
HelpSupportFileType	String	Required	The LOG or FEEDBACK_PHOTO. If LOG is passed, it will be considered as a log file. if FEEDBACK_PHOTO is passed, it will be considered as a feedback photo.

Attribute	Type	Use	Description
`uuid`	String	Optional	The user UUID.
`udid`	String	Optional	The device UDID.
`email`	String	Optional	Customer email that is passed to create a ticket.
`phone`	String	Optional	Customer phone that is passed to create a ticket.
`ticketId`	String	Optional	The Client ticket id.
`zendeskTicketId`	String	Optional	The Zendesk ticket id.

POSTUpload Customer Support File

Description

Uploads a log or feed back photo and depends on the parameter LOG or FEEDBACK_PHOTO respectively. Add a header like: Accept-Encoding : multipart/form-data. The POST upload file parameter name is "file".

Request Endpoint

POST https://<Example api server address>/user/help/file/upload/{feedbackId}/{HelpSupportFileType}

Parameters

Parameter	Type	Use	Description
feedbackId	String	Required	The user feedback id.
HelpSupportFileType	String	Required	The LOG or FEEDBACK_PHOTO file. If LOG is passed, it will be considered as a log file. if FEEDBACK_PHOTO is passed, it will be considered as a feedback photo.

cURL syntax

curl --include \
     --request POST \
'https://core.dev.Example.net/api/user/help/file/upload/feedbackId/HelpSupportFileType'

POST body

Headers: Content-Type: Accept-Encoding : multipart/form-data

LOG or FEEDBACK_PHOTO file

Response body

Headers: Content-Type: application/json | HTTPS Status Code: 200

{
  "data": {
    "id": "9cf778b6-3a4d-49bd-98d2-4214774d3ec0",
    "user": {
      "id": "79af4bc5-a995-4262-92ee-0da381ccaf07",
      "addresses": null,
      "devices": [
        {
          "id": "435bdd41-5347-42c4-9685-a3f66f8dc169",
          "description": "desc",
          "deviceStatus": "NORMAL",
          "manufacturer": "Genymotion",
          "model": "Google Nexus 4 - 4.3 - API 18 - 768x1280",
          "os": "Android:4.3",
          "udid": "7237F578-828D-43D9-995D-F8B7AC8A4881",
          "simStateHashCode": null,
          "simCardState": null,
          "deletedUdid": null,
          "deletedBy": null,
          "deletedOn": null
        }
      ],
      "emailAuthenticationChannels": [],
      "firstName": "John",
      "fullName": "John Connor",
      "groupTag": [
        "Android:4.3",
        "FACEBOOK",
        "Google Nexus 4 - 4.3 - API 18 - 768x1280",
        "Genymotion"
      ],
      "lastName": "Connor",
      "locationCountry": null,
      "locationZipCode": null,
      "mobileAuthenticationChannels": [],
      "pinCreated": true,
      "profileImagePath": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.assets/default-profile-image.png",
      "profileName": "John Connor",
      "registrationDate": 1470298160579,
      "socialAuthenticationChannels": [
        {
          "addedOn": 1470298160579,
          "blockStatus": "NORMAL",
          "deletedOn": null,
          "lastUsedOn": 1470298160579,
          "loginType": "FACEBOOK",
          "socialId": "250078712036810",
          "deleted": false,
          "recycleSocialId": null
        }
      ],
      "status": "NEW",
      "timezone": null,
      "userSetting": {
        "autoUpdateBetcadeApp": true,
        "autoUpdateDownloadedApps": true,
        "monthlyDepositMaxLimit": 0,
        "monthlyDepositMaxLimitCurrency": "GBP",
        "prefillUserInfoInCasino": true,
        "receiveEmailReceipt": true,
        "receiveNotifications": true,
        "shareRegistrationInfo": true,
        "userEmailProvided": true,
        "versionOfDownloadedBetcadeApp": "v1",
        "wifiDownloadLimitInMB": 0,
        "preferredCategories": [],
        "autoSaveCard": true,
        "autoAddHomeIcon": true,
        "receiveUpdateNotifications": true,
        "receiveAutoUpdatedNotifications": true,
        "receiveRecommendationNotifications": true,
        "appSetting": {
          "autoUpdateApps": true,
          "addIconHomeScreen": false,
          "saveNewCreditOrDebitCards": true,
          "appUpdatesAvailable": true,
          "appsWereAutoUpdated": true,
          "recommendedContentAvailable": true
        }
      },
      "verified": true,
      "pinResetDate": null,
      "kycStatus": null,
      "deleted": false,
      "singularId": null,
      "acquisitionIds": null,
      "testUser": null
    },
    "device": {
      "id": "435bdd41-5347-42c4-9685-a3f66f8dc169",
      "description": "desc",
      "deviceStatus": null,
      "manufacturer": "Genymotion",
      "model": "Google Nexus 4 - 4.3 - API 18 - 768x1280",
      "os": "Android:4.3",
      "udid": "7237F578-828D-43D9-995D-F8B7AC8A4881",
      "simStateHashCode": null,
      "simCardState": null,
      "deletedUdid": null,
      "deletedBy": null,
      "deletedOn": null,
      "target": {
        "id": "435bdd41-5347-42c4-9685-a3f66f8dc169",
        "description": "desc",
        "deviceStatus": "NORMAL",
        "manufacturer": "Genymotion",
        "model": "Google Nexus 4 - 4.3 - API 18 - 768x1280",
        "os": "Android:4.3",
        "udid": "7237F578-828D-43D9-995D-F8B7AC8A4881",
        "simStateHashCode": null,
        "simCardState": null,
        "deletedUdid": null,
        "deletedBy": null,
        "deletedOn": null
      }
    },
    "ticketId": "34822e49-8ed3-42fd-87a0-700a6d509102",
    "logPath": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.logging/f3440e8d-c01d-4085-bd46-1a372aaf7ac9.jpg",
    "name": "sudipta",
    "email": "sudipta.bhaumik@innoflexion.com",
    "phone": "+919916248135",
    "category": "cat1",
    "ticketInfo": {
      "id": "34822e49-8ed3-42fd-87a0-700a6d509102",
      "coreTicketNumber": null,
      "supportTicketId": "345",
      "subject": "sub 1@innoflexion.com",
      "message": "msg 1@innoflexion.com",
      "ticketStatus": "CREATED",
      "userTransactionId": null,
      "userId": "79af4bc5-a995-4262-92ee-0da381ccaf07",
      "userName": null,
      "target": {
        "id": "34822e49-8ed3-42fd-87a0-700a6d509102",
        "coreTicketNumber": null,
        "supportTicketId": "345",
        "subject": "sub 1@innoflexion.com",
        "message": "msg 1@innoflexion.com",
        "ticketStatus": "CREATED",
        "userTransactionId": null,
        "userId": "79af4bc5-a995-4262-92ee-0da381ccaf07",
        "userName": null
      }
    },
    "feedbackPhoto": "https://s3-us-west-2.amazonaws.com/btc.inf.apdx.logging/b93fa75b-a0f6-4e56-b56d-19caaa34a6df.jpg",
    "creationDate": 1471515828374
  },
  "detail": null,
  "error": false,
  "message": "User customer support file is uploaded successfully"
}

Return to top

Customer Support APIs

POSTCreate Customer Support

GETDownload Customer Support File

POSTSearch Customer Support

POSTUpload Customer Support File