Insert Cases with Attachments - crmvox

< / >

Insert

Insert Cases with Attachments

URL:

https://{{wolkvox_server}}/server/API/v2/custom/insert.php

Description:

The following API configuration allows us to add cases with attachments.

How does it work?

This API works through a POST request, which requires the following fields for its correct operation:

– The following headers are required in the request:

Wolkvox-Token: {{token}}
Content-Type: application/json

– In the request body, the following fields are required:

operation
case-type
responsible
owner
contact
description
form
status
priority
attachments

REQUEST

KEY	DESCRIPTION	EXAMPLE
Wolkvox-Server	Operation server nomenclature.	‘https://wolkvox_server.crmvox.com/server/API/v2/cases/insertAttach.php’
Wolkvox-Token	Token generated in the CRM module where you will consume the API.	‘Wolkvox-Token: token’
operation	Operation name.	“operation”: “TheOperationName”
case-type	Case type.	“case-type”: “Request”
responsible	Case responsible.	“responsible”: “ADMIN_@mymodule”
owner	Case owner.	“owner”: “ADMIN_@mymodule”
contact	Contact related to the case.	“contact”: “[email protected]”
description	Case description.	“description”: “This is the case description.”
form	This field is used to specify additional details of the case.	“form”:{ “Subject”: “This is an additional field created in the CRM.” }
status	Indicates the current status of the case.	“status”: “open”
priority	Sets the priority of the case.	“priority”: “low”
attachments	You can add attachments in base64 here.	“attachments”: [ ]

REQUEST

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/cases/insertAttach.php',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "operation":"{{operation}}",
    "case-type":"{{case type}}",
    "responsible":"{{responsible}}",
    "owner":"{{owner}}",
    "contact":"{{contact}}",
    "description":"{{description}}",
    "form":{
      "Subject": "{{subject}}"
    },
    "status": "{{status}}",
    "priority":"{{priority}}",
    "attachments": [  ]
}',
  CURLOPT_HTTPHEADER => array(
    'Wolkvox-Token: {{token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location 'https://{{wolkvox_server}}/server/API/v2/cases/insertAttach.php' \
--header 'Wolkvox-Token: {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "operation":"{{operation}}",
    "case-type":"{{case-type}}",
    "responsible":"{{responsible}}",
    "owner":"{{owner}}",
    "contact":"{{contact}}",
    "description":"{{description}}",
    "form":{
      "Subject": "{{subject}}"
    },
    "status": "{{status}}",
    "priority":"{{priority}}",
    "attachments": [  ]
}'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"operation\":\"{{operation}}\",\r\n    \"case-type\":\"{{case-type}}\",\r\n    \"responsible\":\"{{responsible}}\",\r\n    \"owner\":\"{{owner}}\",\r\n    \"contact\":\"{{contact}}\",\r\n    \"description\":\"{{description}}\",\r\n    \"form\":{\r\n      \"Subject\": \"{{subject}}\"\r\n    },\r\n    \"status\": \"{{status}}\",\r\n    \"priority\":\"{{priority}}\",\r\n    \"attachments\": [  ]\r\n}");
Request request = new Request.Builder()
  .url("https://{{wolkvox_server}}/server/API/v2/cases/insertAttach.php")
  .method("POST", body)
  .addHeader("Wolkvox-Token", "{{token}}")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

				
					import requests
import json

url = "https://{{Wolkvox_Server}}/server/API/v2/cases/insertAttach.php"

payload = json.dumps({
  "operation": "{{operation}}",
  "case-type": "{{case-type}}",
  "responsible": "{{responsible}}",
  "owner": "{{owner}}",
  "contact": "{{contact}}",
  "description": "{{description}}",
  "form": {
    "{{campo-adicional}}": "{{valor-del-campo-adicional}}"
  },
  "status": "{{status}}",
  "priority": "{{priority}}",
  "attachments": []
})
headers = {
  'Wolkvox-Token': '{{token}}',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

RESPONSE

				
					{
    "code": 200,
    "error": "null",
    "msg": "Succesfully create record",
    "data": {
        "wolkvox_id": " ",
        "idPrefijo": " "
    }
}

Possible error codes

wolkvox
worldwide

COLOMBIA

Medellín +57 (604) 322 98 80
Bogotá +57 (601) 381 90 40
Cali +57 (602) 891 28 46
Barranquilla +57 (605) 316 10 34

ARGENTINA

Buenos Aires +54 (11) 5217 5933

BRAZIL

Goiânia +55 (62) 99328 6605

CHILE

Santiago de Chile +56 (2) 240 533 89

SPAIN

Madrid +34 (910) 601 691

UNITED STATES

Atlanta +1 (678) 496 7474

GUATEMALA

Ciudad de Guatemala +502 (2) 314 1344

MEXICO

Ciudad de México +52 (55) 8526 36 34

DOMINICAN REPUBLIC

Santo Domingo +1 (829) 249 69 68

PERU

Lima +51 (1) 644 91 39

|

Information security policy

|

Privacy policy and treatment of personal data

Copyright © 2022 MICROSYSLABS S.A.S. Cra 30 # 4A-45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia

OMNICHANNEL PLATFORM

CHATBOTS AND VOICEBOTS

wolkvox worldwide

COLOMBIA
Medellín +57 (4) 322 98 80
Bogotá +57 (1) 381 90 40
Cali +57 (2) 891 28 46
Barranquilla +57 (5) 316 10 34

ARGENTINA
Buenos Aires +54 (11) 5217 5933

SPAIN
Madrid +34 (910) 601 691

MEXICO
Ciudad de México +52 (55) 8526 36 34

BRASIL
Brasilia +55 (61) 9836 4127
São Paulo +55 (12) 9811 155 83

UNITED STATES
New York +1 (914) 373 71 36

DOMINICAN REPUBLIC
Santo Domingo +1 (829) 249 69 68

CHILE
Santiago de Chile +56 (2) 240 533 89

GUATEMALA
Ciudad de Guatemala +502 (2) 314 1344

PERU
Lima +51 (1) 644 91 39

Information security policy

Privacy policy and treatment of personal data

Copyright © 2022 MICROSYSLABS S.A.S.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia