Guía para desarrolladores

Aprende cómo configurar y utilizar nuestras API abiertas,
¡para integrar libremente Deskero con cualquier otra solución de software!

Agents

List

Get a paginated list of agents

GET https://api.deskero.com/agent/list

Headers

Header Value
Authorization Bearer {{bearer}}
Accept application/json
clientId {{clientId}}

URL parameters

Field name Value Required Default
page int value for page to show False 1

Example request

$ curl https://api.deskero.com/agent/list \ 
	-v \
	-H "Accept: application/json" \
	-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
	-H "clientId: 51f01687e4b094c81d7b8bcdellef"

Example response

{
	"agent": {
		"totalRecords": 50,
		"recordsPerPage": 25,
		"previousQuery": null,
		"nextQuery": "https://api.deskero.com/agent/list?page=2",
		"records": [
			See agent detail
		]
	}
}

Search

Search a agent

GET https://api.deskero.com/agent/list

Headers

Header Value
Authorization Bearer {{bearer}}
Accept application/json
clientId {{clientId}}

URL parameters

Field name Value Required Default
page int value for page to show False 1
{{fieldName}} a value to search False

Example request

$ curl https://api.deskero.com/agent/list?name=Gill Miller\ 
	-v \
	-H "Accept: application/json" \
	-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
	-H "clientId: 51f01687e4b094c81d7b8bcdellef"

Example response

{
	"agent": {
		"totalRecords": 1,
		"recordsPerPage": 25,
		"previousQuery": null,
		"nextQuery": null,
		"records": [
			See agent detail
		]
	}
}

Detail

Show a single agent

GET https://api.deskero.com/agent/{{agentId}}

Headers

Header Value
Authorization Bearer {{bearer}}
Accept application/json
clientId {{clientId}}

Example request

$ curl https://api.deskero.com/agent/527a0f95e4b0d3bd74d43929 \ 
	-v \
	-H "Accept: application/json" \
	-H "Authorization: Bearer 58cfg61g-1585-5c72-g35f-7fe76893ed2f" \
	-H "clientId: 51f01687e4b094c81d7b8bcdellef"

Example response

{
	"id": "51d2ff3ce4b0089a60ed3ee6",
	"name": "Gill Miller",
	"sex": null,
	"email": "gillmiller@awesomebooks.com",
	"phoneNumber": null,
	"faxNumber": null,
	"mobileNumber": null,
	"address": null,
	"city": null,
	"province": null,
	"state": null,
	"postalNumber": null,
	"skypeAddress": null,
	"msnAddress": null,
	"gtalkAddress": null,
	"insertDate": null,
	"signature": null,
	"memo": null,
	"language": "en",
	"profilePhotoURL": "https://api.deskero.com/agent/photo/51d2ff3ce4b0089a60ed3ee6",
	"account": {
		See account detail
	}
}

Fields

Field name Description
id auto-generated agent id
name full name
sex m/f
phoneNumber phone number string
faxNumber fax number string
mobileNumber mobile number string
address full address
city city
province province
state two chars iso country code, for example GB
postalNumber postal number string
skypeAddress account skype
msnAddress account msn
gtalkAddress account gtalk
insertDate insert date timestamp
profilePhotoUrl auto-generated photo url, for example https://api.deskero.com/agent/photo/527a0f95e4b0d3bd74d43929
signature agent signature for tickets and replies
memo internal note
language language (en,it,es,fr) for ui and emails
account object with user credentials, see account detail
Cerrar