Child pages
  • WHM API 1 Functions - ticket_create_stub_ticket

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function creates a stub ticket.

The system will use the stub ticket to create a cPanel support ticket.

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/ticket_create_stub_ticket



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/ticket_create_stub_ticket



Expand
titleCommand Line


Code Block
whmapi1 ticket_create_stub_ticket

 

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
 {
	"metadata": {
		"result": 1,
		"version": 1,
		"command": "ticket_create_stub_ticket",
		"reason": "OK"
	},
	"data": {
		"ticket_id": 7648492
		"secure_id": rofh411bv8
	}
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
	<metadata>
		<result>1</result>
		<version>1</version>
		<command>ticket_create_stub_ticket</command>
		<reason>OK</reason>
	</metadata>
	<data>
		<ticket_id>7648492</ticket_id>
		<secure_id>rofh411bv8</secure_id>
	</data>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
ticket_idinteger

The support ticket number that other functions can lookup or make additional changes to the support ticket.

A positive integer.

7648492

secure_idstring

The support ticket's secure ID token.

Note
titleNote:

We added this return in cPanel & WHM version 76.


A string value.rofh411bv8