Skype UDF v1.2 (Sep 15, 2013)

FireFox · November 4, 2010

Skype UDF v1.2

Introduction :

Skype4COM represents the Skype API as objects, with :

methods
properties
events
collections
caching

Skype4COM provides an ActiveX interface to the Skype API. Develop for Skype in a familiar programming environment, such as Visual Studio or Delphi, using preferred scripting languages such as VBScript, PHP, or Javascript.

Requirements :

Skype 3.0+ must be installed
Windows 2000, XP+

Update :

Version 1.2
Fixed _Skype_ProfileGetHandle function

Version 1.1
Fixed _Skype_ChatGetBookmarked function
Added missing _Skype_ChatGetTopic function

Version 1.0
Fixed _Skype_ChatGetAll function

Version 0.9
Fixed Mute value returned by the _Skype_OnEventMute callback function

Version 0.8
Error ObjEvent is set if none already set

Version 0.7
Changed _Skype_GetChatActive to _Skype_GetChatAllActive

Version 0.6
Added _Skype_GetCache
Added _Skype_SetCache
Changed Skype_Error function
Minor bugs fixed

Version 0.5
Fixed _Skype_ChatCreate

Version 0.4
Fixed _Skype_ChatGetMessages
Fixed "Skype - SciTE.au3" script

Version 0.3
Minor changes
Updated Skype in AutoIt example

Version 0.2
Fixed _Skype_ChatAddMembers
Various bugs fixed

_

Functions list : (346)

_Skype_Start
_Skype_Shutdown
_Skype_IsRunning
_Skype_SearchForUsers
_Skype_GetAttachmentStatus
_Skype_ConferenceCount
_Skype_Focus
_Skype_BtnPressed
_Skype_BtnReleased
_Skype_ConnectionStatus
_Skype_ResetCache
_Skype_ProfileSetOnlineStatus
_Skype_Minimize
_Skype_GetMute
_Skype_SetMute
_Skype_ResetIdleTimer
_Skype_EnableApiSecurityContext
_Skype_GetAudioOut
_Skype_SetAudioOut
_Skype_GetAudioIn
_Skype_SetAudioIn
_Skype_GetRinger
_Skype_SetRinger
_Skype_GetAutoAway
_Skype_SetAutoAway
_Skype_GetRingToneStatus
_Skype_SetRingToneStatus
_Skype_GetVideoIn
_Skype_SetVideoIn
_Skype_GetPCSpeaker
_Skype_SetPCSpeaker
_Skype_GetAGC
_Skype_SetAGC
_Skype_GetAEC
_Skype_SetAEC
_Skype_GetLanguage
_Skype_SetLanguage
_Skype_GetSkypeVersion
_Skype_GetProtocol
_Skype_SetProtocol
_Skype_GetApiWrapperVersion
_Skype_GetSilentMode
_Skype_SetSilentMode
_Skype_GetCache
_Skype_SetCache
_Skype_GroupCreate
_Skype_GroupGetCount
_Skype_GroupCustomGetCount
_Skype_GroupHardwiredGetCount
_Skype_GroupDelete
_Skype_GroupRemoveUser
_Skype_GroupAddUser
_Skype_GroupCustomGetDetails
_Skype_GroupHardwiredGetDetails
_Skype_OpenContactsTab
_Skype_OpenSearchDialog
_Skype_OpenProfileDialog
_Skype_OpenOptionsDialog
_Skype_OpenUserInfoDialog
_Skype_OpenMessageDialog
_Skype_OpenFileTransfer
_Skype_OpenLiveTab
_Skype_OpenDialPadTab
_Skype_OpenChat
_Skype_OpenCallHistoryTab
_Skype_OpenSendContactsDialog
_Skype_OpenAuthorizationDialog
_Skype_OpenBlockedUsersDialog
_Skype_OpenImportContactsWizard
_Skype_OpenGettingStartedWizard
_Skype_OpenVideoTestDialog
_Skype_OpenConferenceDialog
_Skype_OpenAddAFriend
_Skype_ChatCreate
_Skype_ChatCreateWith
_Skype_ChatAddMembers
_Skype_ChatMessage
_Skype_ChatAllGetMessagesDetails
_Skype_ChatEnterPassword
_Skype_ChatKickBan
_Skype_ChatKick
_Skype_ChatBookmark
_Skype_ChatUnbookmark
_Skype_ChatSetPassword
_Skype_ChatGetTopic
_Skype_ChatSetTopic
_Skype_ChatOpenWindow
_Skype_ChatSendMessage
_Skype_ChatLeave
_Skype_ChatAlterRemoveUsers
_Skype_ChatAlterAddUsers
_Skype_ChatAlterSetTopic
_Skype_ChatAlterLeave
_Skype_ChatAlterAddMembers
_Skype_ChatCreateMultiple
_Skype_ChatDisband
_Skype_ChatAcceptAdd
_Skype_ChatClearRecentMessages
_Skype_ChatGetName
_Skype_ChatGetMessages
_Skype_ChatGetDate
_Skype_ChatGetAdder
_Skype_ChatGetStatus
_Skype_ChatGetMembers
_Skype_ChatGetMyStatus
_Skype_ChatGetType
_Skype_ChatSetAlertString
_Skype_ChatGetDialogPartner
_Skype_ChatPasswordHint
_Skype_ChatGetActivityDate
_Skype_ChatGetDescription
_Skype_ChatSetDescription
_Skype_ChatGetGuideLines
_Skype_ChatSetGuideLines
_Skype_ChatGetTopicXML
_Skype_ChatSetTopicXML
_Skype_ChatGetFriendlyName
_Skype_ChatGetBlob
_Skype_ChatMessageGetBody
_Skype_ChatMessageGetId
_Skype_ChatMessageGetFromHandle
_Skype_ChatMessageGetDate
_Skype_ChatMessageGetType
_Skype_ChatGetAll
_Skype_ChatGetAllActive
_Skype_ChatGetMissed
_Skype_ChatGetRecent
_Skype_ChatGetBookmarked
_Skype_ChatClearHistory
_Skype_CallCreate
_Skype_CallGetActiveCount
_Skype_CallGetActive
_Skype_CallActiveGetMembers
_Skype_CallGetStatus
_Skype_CallSetStatus
_Skype_CallGetId
_Skype_CallGetDate
_Skype_CallGetConferenceId
_Skype_CallGetType
_Skype_CallGetFailureReason
_Skype_CallGetSubject
_Skype_CallGetPstnNumber
_Skype_CallGetDuration
_Skype_CallGetPstnStatus
_Skype_CallGetSeen
_Skype_CallSetSeen
_Skype_CallSetDTMF
_Skype_CallGetParticipantsCount
_Skype_CallGetParticipants
_Skype_CallGetVideoStatus
_Skype_CallGetVideoSendStatus
_Skype_CallGetVideoReceiveStatus
_Skype_CallGetRate
_Skype_CallGetRateCurrency
_Skype_CallGetRatePrecision
_Skype_CallGetInputDevice
_Skype_CallSetInputDevice
_Skype_CallGetOutputDevice
_Skype_CallSetOutputDevice
_Skype_CallGetCaptureMicDevice
_Skype_CallSetCaptureMicDevice
_Skype_CallGetInputStatus
_Skype_CallGetForwardedBy
_Skype_CallGetCanTransfer
_Skype_CallGetTransferStatus
_Skype_CallGetTransferActive
_Skype_CallGetTransferredBy
_Skype_CallGetTransferredTo
_Skype_CallGetTargetIdentity
_Skype_CallClearHistory
_Skype_CallJoin
_Skype_CallHold
_Skype_CallResume
_Skype_CallFinish
_Skype_CallAnswer
_Skype_CallStartVideoSend
_Skype_CallStopVideoSend
_Skype_CallStartVideoReceive
_Skype_CallStopVideoReceive
_Skype_CallForward
_Skype_CallRedirectToVoicemail
_Skype_ProfileGetHandle
_Skype_ProfileGetContacts
_Skype_ProfileSaveAvatarToFile
_Skype_ProfileLoadAvatarFromFile
_Skype_ProfileGetOnlineStatus
_Skype_ProfileSetFullName
_Skype_ProfileGetFullName
_Skype_ProfileSetBirthday
_Skype_ProfileGetBirthday
_Skype_ProfileSetSex
_Skype_ProfileGetSex
_Skype_ProfileSetCountry
_Skype_ProfileGetCountry
_Skype_ProfileSetProvince
_Skype_ProfileGetProvince
_Skype_ProfileSetCity
_Skype_ProfileGetCity
_Skype_ProfileSetPhoneHome
_Skype_ProfileGetPhoneHome
_Skype_ProfileSetPhoneMobile
_Skype_ProfileGetPhoneMobile
_Skype_ProfileSetHomepage
_Skype_ProfileGetHomepage
_Skype_ProfileSetAbout
_Skype_ProfileGetAbout
_Skype_ProfileSetMoodText
_Skype_ProfileGetMoodText
_Skype_ProfileSetTimezone
_Skype_ProfileGetTimezone
_Skype_ProfileSetCallNoAnswerTimeout
_Skype_ProfileGetCallNoAnswerTimeout
_Skype_ProfileSetCallApplyCF
_Skype_ProfileGetCallApplyCF
_Skype_ProfileSetCallSendToVM
_Skype_ProfileGetCallSendToVM
_Skype_ProfileSetCallForwardRules
_Skype_ProfileGetCallForwardRules
_Skype_ProfileGetBalance
_Skype_ProfileGetBalanceToText
_Skype_ProfileGetIPCountry
_Skype_ProfileGetValidatedSmsNumbers
_Skype_ProfileSetRichMoodText
_Skype_ProfileGetRichMoodText
_Skype_ProfileGetLanguage
_Skype_ProfileSetLanguage
_Skype_OnEventError
_Skype_OnEventAttachmentStatus
_Skype_OnEventConnectionStatus
_Skype_OnEventUserStatus
_Skype_OnEventOnlineStatus
_Skype_OnEventCallStatus
_Skype_OnEventCallHistory
_Skype_OnEventMute
_Skype_OnEventMessageStatus
_Skype_OnEventMessageHistory
_Skype_OnEventAutoAway
_Skype_OnEventCallDtmfReceived
_Skype_OnEventVoicemailStatus
_Skype_OnEventApplicationConnecting
_Skype_OnEventContactsFocused
_Skype_OnEventGroupVisible
_Skype_OnEventGroupExpanded
_Skype_OnEventGroupUsers
_Skype_OnEventGroupDeleted
_Skype_OnEventSmsMessageStatusChanged
_Skype_OnEventSmsTargetStatusChanged
_Skype_OnEventCallInputStatusChanged
_Skype_OnEventAsyncSearchUsersFinished
_Skype_OnEventCallSeenStatusChanged
_Skype_OnEventPluginEventClicked
_Skype_OnEventPluginMenuItemClicked
_Skype_OnEventWallpaperChanged
_Skype_OnEventFileTransferStatusChanged
_Skype_OnEventCallTransferStatusChanged
_Skype_OnEventChatMembersChanged
_Skype_OnEventCallVideoStatusChanged
_Skype_OnEventCallVideoSendStatusChanged
_Skype_OnEventCallVideoReceiveStatusChanged
_Skype_OnEventSilentModeStatusChanged
_Skype_OnEventUILanguageChanged
_Skype_OnEventUserAuthRequestReceived
_Skype_UserGetFullName
_Skype_UserSendMessage
_Skype_UserGetBirthday
_Skype_UserGetSex
_Skype_UserGetCountry
_Skype_UserGetProvince
_Skype_UserGetCity
_Skype_UserGetPhoneHome
_Skype_UserGetPhoneMobile
_Skype_UserGetHomepage
_Skype_UserGetAbout
_Skype_UserGetMoodText
_Skype_UserGetTimezone
_Skype_UserGetRichMoodText
_Skype_UserGetBuddyStatus
_Skype_UserSetBuddyStatus
_Skype_UserGetAuthorized
_Skype_UserSetAuthorized
_Skype_UserGetIsBlocked
_Skype_UserSetIsBlocked
_Skype_UserGetDisplayName
_Skype_UserSetDisplayName
_Skype_UserGetOnlineStatus
_Skype_UserGetLastOnline
_Skype_UserGetReceivedAuthRequest
_Skype_UserGetSpeedDial
_Skype_UserSetSpeedDial
_Skype_UserGetCanLeaveVoicemail
_Skype_UserGetAliases
_Skype_UserGetIsCallForwardActive
_Skype_UserGetLanguage
_Skype_UserGetLanguageCode
_Skype_UserGetIsVideoCapable
_Skype_UserGetIsSkypeOutContact
_Skype_UserGetNumberOfAuthBuddies
_Skype_UserGetIsVoicemailCapable
_Skype_ConvertAttachmentStatus
_Skype_ConvertConnectionStatus
_Skype_ConvertUserStatus
_Skype_ConvertCallFailureReason
_Skype_ConvertCallStatus
_Skype_ConvertCallType
_Skype_ConvertCallHistory
_Skype_ConvertCallVideoStatus
_Skype_ConvertCallVideoSendStatus
_Skype_ConvertCallIoDeviceType
_Skype_ConvertChatMessageType
_Skype_ConvertChatMemberRole
_Skype_ConvertUserSex
_Skype_ConvertBuddyStatus
_Skype_ConvertOnlineStatus
_Skype_ConvertChatLeaveReason
_Skype_ConvertChatStatus
_Skype_ConvertChatType
_Skype_ConvertChatMyStatus
_Skype_ConvertChatOptions
_Skype_ConvertVoicemailType
_Skype_ConvertVoicemailStatus
_Skype_ConvertVoicemailFailureReason
_Skype_ConvertGroupType
_Skype_ConvertCallChannelType
_Skype_ConvertApiSecurityContext
_Skype_ConvertSmsMessageType
_Skype_ConvertSmsMessageStatus
_Skype_ConvertSmsFailureReason
_Skype_ConvertSmsTargetStatus
_Skype_ConvertPluginContext
_Skype_ConvertPluginContactType
_Skype_ConvertFileTransferType
_Skype_ConvertFileTransferStatus
_Skype_ConvertFileTransferFailureReason
_Skype_FileTransfersGetDetails
_Skype_FileTransfersGetActiveDetails
_Skype_SMSSend
_Skype_SMSGetDetails
_Skype_SmsMessageDelete
_Skype_ApplicationCreate
_Skype_ApplicationDelete
_Skype_CreateEvent
_Skype_CreateMenuItem
_Skype_PluginEventDelete
_Skype_PluginMenuItemDelete
_Skype_VoicemailClearHistory
_Skype_VoicemailDelete

Example GUI :

Notes :

Skype's access control must be accepted manually :

After running the example script, click on the "Allow access" button of Skype

This version is NOT complete
If you are running on a 64 bits OS, add this line to your script :
```
#AutoIt3Wrapper_UseX64=n
```

Attachments :

Pack (UDF + ExampleGUI)

Version 1.2 : Skype-UDF_1.0.0.2.zip

Examples : (put them into the "Example folder")

-Answers to incomming calls even if you are already in a call : Auto Answer.au3

-Shows how to use the OnMute event : Mute Event.au3

Happy coding :graduated:

Edited October 22, 2013 by FireFox

AlmarM · November 4, 2010

Huge functions list, great job! :graduated:

autoall · November 4, 2010

nice job! I will test it

twitchyliquid64 · November 5, 2010

Dude you are amazing. This is so going in my downloads folder.

FireFox · November 5, 2010

Thanks for your feedback :graduated:

I have added the "Auto Anwser" example Posted Image

Br, FireFox.

Edited November 5, 2010 by FireFox

joseLB · January 16, 2012

Hi Firefox, great job... I will start to test very soon.

DO you know a place/documentation where I can know what each function does? Maybe at skype homepage?

THANKS

Jose

FireFox · January 17, 2012

Hi Firefox, great job... I will start to test very soon.
DO you know a place/documentation where I can know what each function does? Maybe at skype homepage?
THANKS
Jose

You've got a description for each function in the UDF.

I don't think that the manual available will help you, link here

Br, FireFox.

Edited January 17, 2012 by FireFox

Danyfirex · October 4, 2012

Excelent job FireFox. thank you so much.

FireFox · October 4, 2012

Thanks !, I have worked on it for many days. I'm happy to have a feedback like yours because they are not as numerous as you can see.

Br, FireFox.

Edited October 4, 2012 by FireFox

guwguw · October 28, 2012

Hi there,

I just ran across this by accident and it reminded me of a problem I tried to solve a few months ago, but wasn't able to:

I can send messages to every single member of my Skype list, but we have a "group" that I tried to inform about a set of values at regular intervals (about once every 4 hours).

The problem is that this step works, if I create a group and adress it, but for some unknown reason, our existing "group" (I'm writing it in parentheses, because Skype seems to treat it as something other than a group - and sadly, I did not create it) is not treated as such and DOES NOT show in the list of participants when I run your "Skype in AutoIT.au3".

In my actual Skype contact's list, it shows with a logo similar to the "Online" symbol, but with a circle of 6 white points around the center.

If I remember right, the lines

$ichat = $oSkype.get_Chat("#xyz.dev/$febc24a082b613eb")
For $aChat In $ichat.Chats
If $aChat.Timestamp >= "20120907000149" Then
$msgstring = $msgstring & @CR & $aChat.Timestamp & " | Groupname:" & $aChat.GroupName & " | Name:" & $aChat.Name & "| FriendlyName:" & $aChat.FriendlyName
ConsoleWrite("-> " & @ScriptLineNumber & " " & $msgstring & @CRLF)
EndIf
Next

worked correctly on all other groups, but not this one.

$oSkype.RecentChats reports all chats of that group with the name ("#xyz.dev/$febc24a082b613eb"), but all attempts at sending them a message with either $oSkype.SendMessage(...) or $oSkype.Client.OpenUserInfoDialog("#xyz.dev/$febc24a082b613eb") and similar fail.

Your function displayChatProperties($aChat) reports

(Label: some group of people - sensible easygoing chat.. (sun)

Created at: 20120603013930

Last activity at: 20121028162704

Id: #xyz.dev/$febc24a082b613eb

Blob: 9Ec90D8ftJYM4SvdywDZqXIzfMdkVvWkDU ... vlCwtU3h5QmoQEZJuCeZDYVA

Description:

Guidelines:

My role: Master

My status: Subscribed

Type: Multichat

Members:

member1

member 2

memberxyz

memberetc.

Is anybody aware of a special command to send a message to a multichat (I couldn't fond any in the Skype docs either)?

FireFox · October 28, 2012

@guwguw

Maybe the UDF is deprecated due to new Skype functions.

The only way for me to help you would to test it, so add me in skype you will find my ID on my profile.

Br, FireFox.

guwguw · October 29, 2012

@guwguw
Maybe the UDF is deprecated due to new Skype functions.

I doubt that: I'm using version 4.2.0.187

will get in touch via Skype later tonight

FireFox · October 30, 2012

This is the solution for our friend :

#include "Skype.au3"

Global $aChat = _Skype_ChatGetActive(), $oChat

For $iChat = 0 To UBound($aChat) -1
 $oChat = $aChat[$iChat]
 If _Skype_ChatGetName($oChat) = "#abc.def/$febc24a082b613eb" Then ExitLoop ;we've found the chat name
Next

_Skype_ChatSendMessage($oChat, "test") ;send test to the chat

Be reminded that you must store the object in a variable before using it ! (it won't work if you use it directly with the array)

@everybody

New version available ! (see first post for update)

frank10 · November 26, 2012

Hi, I am running Skype 6.0 on my W7.

your UDF doesn't work on autoit 64bit.

So you could put this line in your example script:

#AutoIt3Wrapper_UseX64=n

With that it works always well.

How do you use your UDF to make a VideoCall?

Thank you

FireFox · November 26, 2012

So you could put this line in your example script:

OK I will add this under "Notes".

How do you use your UDF to make a VideoCall?

hm... never tested it, I will give it a try.

Br, FireFox.

FireFox · November 26, 2012

I have just tested it and it won't work as you expected.

First, you have to make a simple call and when this one is in progress start the video.

Note that your contact will have to click on the webcam button to activate it on his side.

#include "Skype.au3"

_Skype_OnEventCallStatus("CallStatusEvent_InProgress", $cClsInProgress)

;~ _Skype_UserGetIsVideoCapable ;you can use it to check if the video call is possible

Global $oCall = _Skype_CallCreate("useridhere")

While 1
    Sleep(1000)
WEnd

Func CallStatusEvent_InProgress($oCall)
    _Skype_CallStartVideoSend($oCall)
    _Skype_CallStartVideoReceive($oCall)
EndFunc

Br, FireFox.

Edited November 26, 2012 by FireFox

frank10 · November 26, 2012

Thank you.

Another useful thing could be to determine which webcam to use/switch from the pc.

I am searching another thing: I would like to receive on my phone a call with more information just near the user name.

I have a prog that makes a call to phone from the pc and I want to recognize which action took place.

The only thing I got is make the call, answer it, then send a message during the call and open it to know the reason.

It could be a lot better if i could put the text near the user caller so I don't need to answer.

It needs the call because sending only the message doesn't make the cell ring loud and for some time.

Edited November 26, 2012 by frank10

FireFox · November 27, 2012

Another useful thing could be to determine which webcam to use/switch from the pc.

Well, I don't think it's possible. You can get and set the video devices with the _Skype_[set/Get]VideoIn functions.

I suggest you to list your video devices by switching them manually from Skype and then getting them with the _Skype_GetVideoIn func.

I think that Skype will return an error if you try to set a video device not connected.

In case it's not working you will have to use an external application to check the video device.

I am searching another thing: I would like to receive on my phone a call with more information just near the user name.
I have a prog that makes a call to phone from the pc and I want to recognize which action took place.

The only thing I got is make the call, answer it, then send a message during the call and open it to know the reason.
It could be a lot better if i could put the text near the user caller so I don't need to answer.

It needs the call because sending only the message doesn't make the cell ring loud and for some time.

I don't understand what you mean by "more information" and "recognize which action".

Br, FireFox.

frank10 · November 27, 2012

SetVideoIn works well to select the correct webcam before starting the call, but it doesn't change the webcam during the call, like this:

_Skype_SetVideoIn('HP Webcam HD-4110')

_Skype_OnEventCallStatus("CallStatusEvent_InProgress", $cClsInProgress)
Global $oCall = _Skype_CallCreate("Francesem10")

While 1
    Sleep(30000)
    _Skype_SetVideoIn('Philips SPC 900NC PC Camera')
    _Skype_CallStartVideoSend($oCall)


WEnd

It blacks the pic for some seconds but then it continues with the first webcam.

While if I make these steps manually, it works also during a call:

Make call, options-> Video Settings ->select new webcam-> save webcam

then video->start video

the Videocall changes the webcam video.

I was thinking if there is something similar in skype4com, maybe it lacks the "start video" command to reinitialize the new webcam.

For the other problem, I mean: if I get action1 in the pc I will send a text like "action1 occurred", for action2 I will send "action2" and so on.

At this time i send this text in the instant message comunication after I answer the call.

I'm asking if it's possible to incorporate some text message directly near the user caller when the phone rings.

BTW:

there is a typo in the description of this func:

Func _Skype_CallStopVideoReceive($oCall)

it's called startVideo

FireFox · November 27, 2012

SetVideoIn works well to select the correct webcam before starting the call, but it doesn't change the webcam during the call
It blacks the pic for some seconds but then it continues with the first webcam.

It's maybe an API issue.

Try this (not tested) :

...
_Skype_OnEventCallVideoStatusChanged("CallVideoStatusEvent")

;your script with video call
$oCall = ...

Func CallVideoStatusEvent($oCall, $TCallVideoStatus)
    If $TCallVideoStatus = $cCvsBothEnabled Then
;~      _Skype_CallStopVideoSend($oCall) ;uncomment this in case the script does not work
;~      _Skype_CallStopVideoReceive($oCall) ;same

        _Skype_SetVideoIn(...)

        _Skype_CallStartVideoSend($oCall)
        _Skype_CallStartVideoReceive($oCall)
    EndIf
EndFunc

For the other problem, I mean: if I get action1 in the pc I will send a text like "action1 occurred", for action2 I will send "action2" and so on.
At this time i send this text in the instant message comunication after I answer the call.
I'm asking if it's possible to incorporate some text message directly near the user caller when the phone rings.

Hm... try _Skype_ProfileGet/SetMoodText, but I don't see the problem of sending a message (notifications?)

BTW:
there is a typo in the description of this func:
Func _Skype_CallStopVideoReceive($oCall)
it's called startVideo

Right, when you make a thousand of functions you just stop checking what you have done

@everyone

New version available !

Br, FireFox.

Edited November 27, 2012 by FireFox

Skype UDF v1.2 (Sep 15, 2013)

Recommended Posts

Top Posters In This Topic

Top Posters In This Topic

Popular Posts

FireFox

Danyfirex

FireFox

Create an account or sign in to comment

Create an account

Sign in

Recently Browsing 0 members

Similar Content