Skype Actions (v.3.0)
From Skip2PBX-WIKI
Contents |
Call related actions
call-start
This action starts a new call with a remote Skype destination.
Action Variables
- user-name: The Skype destination to call
Returned variables
- call-id: The new call
Errors
- invalid-argument: A required argument is missing or misspelled
- unknown_call_error: The call does not exist
call-hangup
This action closes an existing Skype call.
Action Variables
- call-id: The call to close
Errors
- invalid-argument: A required argument is missing or misspelled
call-transfer
This action transfers a Skype call to a different Skype destination.
Action Variables
- call-id: The call to transfer
- user-name: The Skype destination to transfer the call to
Errors
- invalid-argument: A required argument is missing or misspelled
- cannot_transfer: The call cannot be transferred
call-vm
This action transfers a Skype call to the Skype voicemail if it is enabled.
The call must be in ringing status to accomplish this operation.
Action Variables
- call-id: The call to redirect to the voicemail
Errors
- invalid-argument: A required argument is missing or misspelled
call-answer
This action answers an incoming Skype call.
Action Variables
- call-id: The call to be answered
Errors
- invalid-argument: A required argument is missing or misspelled
call-hold
This action puts a Skype call on hold.
Action Variables
- call-id: The call to be placed on hold
Errors
- invalid-argument: A required argument is missing or misspelled
call-resume
This action resumes a Skype call previously put to on-hold.
The call must be in onhold status and it must be placed on-hold from the local side.
Action Variables
- call-id: The on hold call to be resumed
Errors
- invalid-argument: A required argument is missing or misspelled
call-dtmf
This action sends a DTMF code thought the Skype protocol.
Action Variables
- call-id: The inprogress call
- code: The DTMF code to send
Errors
- invalid-argument: A required argument is missing or misspelled
call-set-input-file
This action uses a WAV file instead of a voice channel to give a playback to the remote user.
This is useful to create custom automated messages.
Action Variables
- call-id: The call
- file-name: The file to be played
Errors
- invalid-argument: A required argument is missing or misspelled
- file_missing: The file does not exist
call-set-output-file
This action redirects the voice of the remote user into a WAV file instead of a voice channel.
This is useful to create a custom answering machine.
Action Variables
- call-id: The call
- file-name: The file to which redirect the voice
Errors
- invalid-argument: A required argument is missing or misspelled
- file_exists: The file already exists (Skip2PBX does not overwrite)
call-conference
This action creates a call conference adding a new Skype destination to the current call.
Action Variables
- call-id: The inprogress call
- conference-user-name: The Skype destination to be added in conference
Returned variables
- conference-call-id: The new call
Errors
- invalid-argument: A required argument is missing or misspelled
- unknown_call_error: The call does not exist
get-call-id
This action returns the call-id of the call in progress with a Skype destination.
Action Variables
- user-name: The Skype destination to search
Returned variables
- call-id: The call
Errors
- invalid-argument: A required argument is missing or misspelled
- no_calls_found: No calls active with such Skype destination
calls-list
This action returns the list of Skype destinations called from a Skype client.
You can have more than one Skype destination for one account if you have started a conference call.
Returned variables
- 1: The first Skype destination
- 2: The second Skype destination
- ...: ...
- n: The n-th Skype destination
File transfer related actions
file-send
This action sends a file to a remote Skype user.
NOTE: This function is EXPERIMENTAL and should not be used in a production environment.
Action Variables
- user-name: The Skype user to send the file to
- file: The file path
Errors
- invalid-argument: A required argument is missing or misspelled
- file_missing: The file does not exist
Chat related actions
chat-leave
This action closes one previously opened chat.
Action Variables
- chat-name: The chat to be closed
Errors
- invalid-argument: A required argument is missing or misspelled
chatmessage-send
This action sends a message to a remote Skype user.
Action Variables
- user-name: The Skype user to send the message to
- message-body: The text of the message to be sent
Returned variables
- chat-name: The used chat or the newly created
Errors
- invalid-argument: A required argument is missing or misspelled
SMS related actions
sms-send
This action sends an SMS message to a mobile phone number.
NOTE: In order to use this function you must have SkypeOUT credit.
Action Variables
- sms-number: The mobile phone number
- sms-body: The SMS text to be sent
Errors
- invalid-argument: A required argument is missing or misspelled
- cannot_send: Cannot send the SMS
Users related actions
user-set-auth
This action authorizes or deny one Skype user that asked to add you to his/her buddy list.
The variable status can have two values:
- True: The request is acknowledged
- False: The request is refused
Action Variables
- user-name: The Skype user to authorize
- status: True or False
Errors
- invalid-argument: A required argument is missing or misspelled
user-set-block
This action stops a Skype user. Stopping a Skype user means that he/she will not be allowed to send you messages, calls or interact with you in any way.
In other words a blocked user is an user in your blacklist.
The variable status can have two values:
- True: The user is blacklisted
- False: The user is not blacklisted
Action Variables
- user-name: The Skype user to be blacklisted
- status: True or False
Errors
- invalid-argument: A required argument is missing or misspelled
user-set-buddy
This action adds or removes in your buddy list one Skype user.
The variable status can have two values:
- True: The user is addedd
- False: Teh user is deleted
Action Variables
- user-name: The Skype user to be added or removed
- status: True or False
Errors
- invalid-argument: A required argument is missing or misspelled
User profile related actions
get-profile-balance
This action retrieves the SkypeOUT credit balance for the current Skype instance.
NOTE: The balance is expressed in integer format. 1.05 euros becomes 105
Returned variables
- balance: The credit
- balance-currency: The currency
Errors
- invalid-argument: A required argument is missing or misspelled
get-user
This action retrieves the Skype profile of a Skype user.
Action Variables
- user-name: The Skype user to be checked
Returned variables
- user-handle: The Skype username
- user-fullname: The Skype user's full name
- user-dispname: The display name
- user-birthday: The User's birthdate
- user-sex: User's gender
- user-language: User's language
- user-country: User's country
- user-province: User's province
- user-city: User's city
- user-phone-home: User's homephone
- user-phone-office: User's office phone
- user-phone-mobile: User's mobile
- user-homepage: User's home page
- user-isauthorized: True if the user has been authorized for the buddylist
- user-isblocked: True if the user has been blocklisted by you
- user-onlinestatus: The user's on-line status
- user-mood-text: The catchphrase displayed in the profile
- user-rich-mood-text: The catchphrase displayed in the profile
- user-timezone: The user's timezone
- user-buddystatus: 0, 1 or 2 depending on the user's presence in your buddylist
Errors
- invalid-argument: A required argument is missing or misspelled
Systemwide ralated actions
list-registered
This action returns the list of currently running Skype accounts in the server.
Returned variables
- 1: The first registered account
- 2: The second registered account
- ...: ...
- n: The n-th registered account
