Full API

If you are looking for information on a specific function, class, or method, this part of the documentation is for you.

Client

This is the main class of fbchat, which contains all the methods you use to interract with Facebook. You can extend this class, and overwrite the events, to provide custom event handling (mainly used while listening)

class fbchat.Client(email, password, user_agent=None, max_tries=5, session_cookies=None, logging_level=logging.INFO)[source]

Initializes and logs in the client

Parameters:
  • email – Facebook email, id or phone number
  • password – Facebook account password
  • user_agent – Custom user agent to use when sending requests. If None, user agent will be chosen from a premade list (see utils.USER_AGENTS)
  • max_tries (int) – Maximum number of times to try logging in
  • session_cookies (dict) – Cookies from a previous session (Will default to login if these are invalid)
  • logging_level (int) – Configures the logging level. Defaults to INFO
Raises:

FBchatException on failed login

addUsersToGroup(user_ids, thread_id=None)[source]

Adds users to a group.

Parameters:
  • user_ids (list) – One or more user IDs to add
  • thread_id – Group ID to add people to. See Threads
Raises:

FBchatException if request failed

changeNickname(nickname, user_id, thread_id=None, thread_type=ThreadType.USER)[source]

Changes the nickname of a user in a thread

Parameters:
  • nickname – New nickname
  • user_id – User that will have their nickname changed
  • thread_id – User/Group ID to change color of. See Threads
  • thread_type (models.ThreadType) – See Threads
Raises:

FBchatException if request failed

changeThreadColor(color, thread_id=None)[source]

Changes thread color

Parameters:
Raises:

FBchatException if request failed

changeThreadEmoji(emoji, thread_id=None)[source]

Changes thread color

Trivia: While changing the emoji, the Facebook web client actually sends multiple different requests, though only this one is required to make the change

Parameters:
  • color – New thread emoji
  • thread_id – User/Group ID to change emoji of. See Threads
Raises:

FBchatException if request failed

changeThreadTitle(title, thread_id=None, thread_type=ThreadType.USER)[source]

Changes title of a thread. If this is executed on a user thread, this will change the nickname of that user, effectively changing the title

Parameters:
Raises:

FBchatException if request failed

doOneListen(markAlive=True)[source]

Does one cycle of the listening loop. This method is useful if you want to control fbchat from an external event loop

Parameters:markAlive (bool) – Whether this should ping the Facebook server before running
Returns:Whether the loop should keep running
Return type:bool
eventReminder(thread_id, time, title, location='', location_id='')[source]

Sets an event reminder

..warning::
Does not work in Python2.7
..todo::
Make this work in Python2.7
Parameters:
  • thread_id – User/Group ID to send event to. See Threads
  • time – Event time (unix time stamp)
  • title – Event title
  • location – Event location name
  • location_id – Event location ID
Raises:

FBchatException if request failed

fetchAllUsers()[source]

Gets all users the client is currently chatting with

Returns:models.User objects
Return type:list
Raises:FBchatException if request failed
fetchGroupInfo(*group_ids)[source]

Get groups’ info from IDs, unordered

Parameters:group_ids – One or more group ID(s) to query
Returns:models.Group objects, labeled by their ID
Return type:dict
Raises:FBchatException if request failed
fetchImageUrl(image_id)[source]

Fetches the url to the original image from an image attachment ID

Parameters:image_id (str) – The image you want to fethc
Returns:An url where you can download the original image
Return type:str
Raises:FBChatException if request failed
fetchPageInfo(*page_ids)[source]

Get pages’ info from IDs, unordered

Warning

Sends two requests, to fetch all available info!

Parameters:page_ids – One or more page ID(s) to query
Returns:models.Page objects, labeled by their ID
Return type:dict
Raises:FBchatException if request failed
fetchThreadInfo(*thread_ids)[source]

Get threads’ info from IDs, unordered

Warning

Sends two requests if users or pages are present, to fetch all available info!

Parameters:thread_ids – One or more thread ID(s) to query
Returns:models.Thread objects, labeled by their ID
Return type:dict
Raises:FBchatException if request failed
fetchThreadList(offset=None, limit=20, thread_location=ThreadLocation.INBOX, before=None)[source]

Get thread list of your facebook account

Parameters:
  • offset – Deprecated. Do not use!
  • limit (int) – Max. number of threads to retrieve. Capped at 20
  • thread_location – models.ThreadLocation: INBOX, PENDING, ARCHIVED or OTHER
  • before (int) – A timestamp (in milliseconds), indicating from which point to retrieve threads
Returns:

models.Thread objects

Return type:

list

Raises:

FBchatException if request failed

fetchThreadMessages(thread_id=None, limit=20, before=None)[source]

Get the last messages in a thread

Parameters:
  • thread_id – User/Group ID to get messages from. See Threads
  • limit (int) – Max. number of messages to retrieve
  • before (int) – A timestamp, indicating from which point to retrieve messages
Returns:

models.Message objects

Return type:

list

Raises:

FBchatException if request failed

fetchUnread()[source]

Get the unread thread list

Returns:List of unread thread ids
Return type:list
Raises:FBchatException if request failed
fetchUnseen()[source]

Get the unseen (new) thread list

Returns:List of unseen thread ids
Return type:list
Raises:FBchatException if request failed
fetchUserInfo(*user_ids)[source]

Get users’ info from IDs, unordered

Warning

Sends two requests, to fetch all available info!

Parameters:user_ids – One or more user ID(s) to query
Returns:models.User objects, labeled by their ID
Return type:dict
Raises:FBchatException if request failed
friendConnect(friend_id)[source]

Todo

Documenting this

getSession()[source]

Retrieves session cookies

Returns:A dictionay containing session cookies
Return type:dict
graphql_request(query)[source]

Shorthand for graphql_requests(query)[0]

Raises:FBchatException if request failed
graphql_requests(*queries)[source]

Todo

Documenting this

Raises:FBchatException if request failed
isLoggedIn()[source]

Sends a request to Facebook to check the login status

Returns:True if the client is still logged in
Return type:bool
listen(markAlive=True)[source]

Initializes and runs the listening loop continually

Parameters:markAlive (bool) – Whether this should ping the Facebook server each time the loop runs
listening = False

Whether the client is listening. Used when creating an external event loop to determine when to stop listening

login(email, password, max_tries=5)[source]

Uses email and password to login the user (If the user is already logged in, this will do a re-login)

Parameters:
  • email – Facebook email or id or phone number
  • password – Facebook account password
  • max_tries (int) – Maximum number of times to try logging in
Raises:

FBchatException on failed login

logout()[source]

Safely logs out the client

Parameters:timeout – See requests timeout
Returns:True if the action was successful
Return type:bool
markAsDelivered(thread_id, message_id)[source]

Mark a message as delivered

Parameters:
  • thread_id – User/Group ID to which the message belongs. See Threads
  • message_id – Message ID to set as delivered. See Threads
Returns:

Whether the request was successful

Raises:

FBchatException if request failed

markAsRead(thread_id)[source]

Mark a thread as read All messages inside the thread will be marked as read

Parameters:thread_id – User/Group ID to set as read. See Threads
Returns:Whether the request was successful
Raises:FBchatException if request failed
markAsSeen()[source]

Todo

Documenting this

on2FACode()[source]

Called when a 2FA code is needed to progress

onChatTimestamp(buddylist=None, msg=None)[source]

Called when the client receives chat online presence update

Parameters:
  • buddylist – A list of dicts with friend id and last seen timestamp
  • msg – A full set of the data recieved
onColorChange(mid=None, author_id=None, new_color=None, thread_id=None, thread_type=ThreadType.USER, ts=None, metadata=None, msg=None)[source]

Called when the client is listening, and somebody changes a thread’s color

Parameters:
  • mid – The action ID
  • author_id – The ID of the person who changed the color
  • new_color (models.ThreadColor) – The new color
  • thread_id – Thread ID that the action was sent to. See Threads
  • thread_type (models.ThreadType) – Type of thread that the action was sent to. See Threads
  • ts – A timestamp of the action
  • metadata – Extra metadata about the action
  • msg – A full set of the data recieved
onEmojiChange(mid=None, author_id=None, new_emoji=None, thread_id=None, thread_type=ThreadType.USER, ts=None, metadata=None, msg=None)[source]

Called when the client is listening, and somebody changes a thread’s emoji

Parameters:
  • mid – The action ID
  • author_id – The ID of the person who changed the emoji
  • new_emoji – The new emoji
  • thread_id – Thread ID that the action was sent to. See Threads
  • thread_type (models.ThreadType) – Type of thread that the action was sent to. See Threads
  • ts – A timestamp of the action
  • metadata – Extra metadata about the action
  • msg – A full set of the data recieved
onFriendRequest(from_id=None, msg=None)[source]

Called when the client is listening, and somebody sends a friend request

Parameters:
  • from_id – The ID of the person that sent the request
  • msg – A full set of the data recieved
onInbox(unseen=None, unread=None, recent_unread=None, msg=None)[source]

Todo

Documenting this

Parameters:
  • unseen

  • unread

  • recent_unread

  • msg – A full set of the data recieved
onListenError(exception=None)[source]

Called when an error was encountered while listening

Parameters:exception – The exception that was encountered
Returns:Whether the loop should keep running
onListening()[source]

Called when the client is listening

onLoggedIn(email=None)[source]

Called when the client is successfully logged in

Parameters:email – The email of the client
onLoggingIn(email=None)[source]

Called when the client is logging in

Parameters:email – The email of the client
onMarkedSeen(threads=None, seen_ts=None, ts=None, metadata=None, msg=None)[source]

Called when the client is listening, and the client has successfully marked threads as seen

Parameters:
  • threads – The threads that were marked
  • author_id – The ID of the person who changed the emoji
  • seen_ts – A timestamp of when the threads were seen
  • ts – A timestamp of the action
  • metadata – Extra metadata about the action
  • msg – A full set of the data recieved
onMessage(mid=None, author_id=None, message=None, message_object=None, thread_id=None, thread_type=ThreadType.USER, ts=None, metadata=None, msg=None)[source]

Called when the client is listening, and somebody sends a message

Parameters:
  • mid – The message ID
  • author_id – The ID of the author
  • message – (deprecated. Use message_object.text instead)
  • message_object (models.Message) – The message (As a Message object)
  • thread_id – Thread ID that the message was sent to. See Threads
  • thread_type (models.ThreadType) – Type of thread that the message was sent to. See Threads
  • ts – The timestamp of the message
  • metadata – Extra metadata about the message
  • msg – A full set of the data recieved
onMessageDelivered(msg_ids=None, delivered_for=None, thread_id=None, thread_type=ThreadType.USER, ts=None, metadata=None, msg=None)[source]

Called when the client is listening, and somebody marks messages as delivered

Parameters:
  • msg_ids – The messages that are marked as delivered
  • delivered_for – The person that marked the messages as delivered
  • thread_id – Thread ID that the action was sent to. See Threads
  • thread_type (models.ThreadType) – Type of thread that the action was sent to. See Threads
  • ts – A timestamp of the action
  • metadata – Extra metadata about the action
  • msg – A full set of the data recieved
onMessageError(exception=None, msg=None)[source]

Called when an error was encountered while parsing recieved data

Parameters:
  • exception – The exception that was encountered
  • msg – A full set of the data recieved
onMessageSeen(seen_by=None, thread_id=None, thread_type=ThreadType.USER, seen_ts=None, ts=None, metadata=None, msg=None)[source]

Called when the client is listening, and somebody marks a message as seen

Parameters:
  • seen_by – The ID of the person who marked the message as seen
  • thread_id – Thread ID that the action was sent to. See Threads
  • thread_type (models.ThreadType) – Type of thread that the action was sent to. See Threads
  • seen_ts – A timestamp of when the person saw the message
  • ts – A timestamp of the action
  • metadata – Extra metadata about the action
  • msg – A full set of the data recieved
onNicknameChange(mid=None, author_id=None, changed_for=None, new_nickname=None, thread_id=None, thread_type=ThreadType.USER, ts=None, metadata=None, msg=None)[source]

Called when the client is listening, and somebody changes the nickname of a person

Parameters:
  • mid – The action ID
  • author_id – The ID of the person who changed the nickname
  • changed_for – The ID of the person whom got their nickname changed
  • new_nickname – The new nickname
  • thread_id – Thread ID that the action was sent to. See Threads
  • thread_type (models.ThreadType) – Type of thread that the action was sent to. See Threads
  • ts – A timestamp of the action
  • metadata – Extra metadata about the action
  • msg – A full set of the data recieved
onPeopleAdded(mid=None, added_ids=None, author_id=None, thread_id=None, ts=None, msg=None)[source]

Called when the client is listening, and somebody adds people to a group thread

Parameters:
  • mid – The action ID
  • added_ids – The IDs of the people who got added
  • author_id – The ID of the person who added the people
  • thread_id – Thread ID that the action was sent to. See Threads
  • ts – A timestamp of the action
  • msg – A full set of the data recieved
onPersonRemoved(mid=None, removed_id=None, author_id=None, thread_id=None, ts=None, msg=None)[source]

Called when the client is listening, and somebody removes a person from a group thread

Parameters:
  • mid – The action ID
  • removed_id – The ID of the person who got removed
  • author_id – The ID of the person who removed the person
  • thread_id – Thread ID that the action was sent to. See Threads
  • ts – A timestamp of the action
  • msg – A full set of the data recieved
onQprimer(ts=None, msg=None)[source]

Called when the client just started listening

Parameters:
  • ts – A timestamp of the action
  • msg – A full set of the data recieved
onTitleChange(mid=None, author_id=None, new_title=None, thread_id=None, thread_type=ThreadType.USER, ts=None, metadata=None, msg=None)[source]

Called when the client is listening, and somebody changes the title of a thread

Parameters:
  • mid – The action ID
  • author_id – The ID of the person who changed the title
  • new_title – The new title
  • thread_id – Thread ID that the action was sent to. See Threads
  • thread_type (models.ThreadType) – Type of thread that the action was sent to. See Threads
  • ts – A timestamp of the action
  • metadata – Extra metadata about the action
  • msg – A full set of the data recieved
onTyping(author_id=None, status=None, thread_id=None, thread_type=None, msg=None)[source]

Called when the client is listening, and somebody starts or stops typing into a chat

Parameters:
  • author_id – The ID of the person who sent the action
  • status – The typing status
  • thread_id – Thread ID that the action was sent to. See Threads
  • thread_type (models.ThreadType) – Type of thread that the action was sent to. See Threads
  • msg – A full set of the data recieved
onUnknownMesssageType(msg=None)[source]

Called when the client is listening, and some unknown data was recieved

Parameters:msg – A full set of the data recieved
reactToMessage(message_id, reaction)[source]

Reacts to a message

Parameters:
Raises:

FBchatException if request failed

removeUserFromGroup(user_id, thread_id=None)[source]

Removes users from a group.

Parameters:
  • user_id – User ID to remove
  • thread_id – Group ID to remove people from. See Threads
Raises:

FBchatException if request failed

resetDefaultThread()[source]

Resets default thread

searchForGroups(name, limit=1)[source]

Find and get group thread by its name

Parameters:
  • name – Name of the group thread
  • limit – The max. amount of groups to fetch
Returns:

models.Group objects, ordered by relevance

Return type:

list

Raises:

FBchatException if request failed

searchForPages(name, limit=1)[source]

Find and get page by its name

Parameters:name – Name of the page
Returns:models.Page objects, ordered by relevance
Return type:list
Raises:FBchatException if request failed
searchForThreads(name, limit=1)[source]

Find and get a thread by its name

Parameters:
  • name – Name of the thread
  • limit – The max. amount of groups to fetch
Returns:

models.User, models.Group and models.Page objects, ordered by relevance

Return type:

list

Raises:

FBchatException if request failed

searchForUsers(name, limit=1)[source]

Find and get user by his/her name

Parameters:
  • name – Name of the user
  • limit – The max. amount of users to fetch
Returns:

models.User objects, ordered by relevance

Return type:

list

Raises:

FBchatException if request failed

send(message, thread_id=None, thread_type=ThreadType.USER)[source]

Sends a message to a thread

Parameters:
Returns:

Message ID of the sent message

Raises:

FBchatException if request failed

sendEmoji(emoji=None, size=EmojiSize.SMALL, thread_id=None, thread_type=ThreadType.USER)[source]

Deprecated. Use fbchat.Client.send instead

sendImage(image_id, message=None, thread_id=None, thread_type=ThreadType.USER, is_gif=False)[source]

Deprecated. Use fbchat.Client.send instead

sendLocalImage(image_path, message=None, thread_id=None, thread_type=ThreadType.USER)[source]

Sends a local image to a thread

Parameters:
  • image_path – Path of an image to upload and send
  • message – Additional message
  • thread_id – User/Group ID to send to. See Threads
  • thread_type (models.ThreadType) – See Threads
Returns:

Message ID of the sent image

Raises:

FBchatException if request failed

sendMessage(message, thread_id=None, thread_type=ThreadType.USER)[source]

Deprecated. Use fbchat.Client.send instead

sendRemoteImage(image_url, message=None, thread_id=None, thread_type=ThreadType.USER)[source]

Sends an image from a URL to a thread

Parameters:
  • image_url – URL of an image to upload and send
  • message – Additional message
  • thread_id – User/Group ID to send to. See Threads
  • thread_type (models.ThreadType) – See Threads
Returns:

Message ID of the sent image

Raises:

FBchatException if request failed

setDefaultThread(thread_id, thread_type)[source]

Sets default thread to send messages to

Parameters:
setSession(session_cookies)[source]

Loads session cookies

Parameters:session_cookies (dict) – A dictionay containing session cookies
Returns:False if session_cookies does not contain proper cookies
Return type:bool
setTypingStatus(status, thread_id=None, thread_type=None)[source]

Sets users typing status in a thread

Parameters:
Raises:

FBchatException if request failed

ssl_verify = True

Verify ssl certificate, set to False to allow debugging with a proxy

startListening()[source]

Start listening from an external event loop

Raises:FBchatException if request failed
stopListening()[source]

Cleans up the variables from startListening

uid = None

The ID of the client. Can be used as thread_id. See Threads for more info.

Note: Modifying this results in undefined behaviour

Models

These models are used in various functions, both as inputs and return values. A good tip is to write from fbchat.models import * at the start of your source, so you can use these models freely

class fbchat.models.Attachment(uid=None)[source]

Represents a Facebook attachment

uid = None

The attachment ID

class fbchat.models.AudioAttachment(filename=None, url=None, duration=None, audio_type=None, **kwargs)[source]

Represents an audio file that has been sent as a Facebook attachment

audio_type = None

Audio type

duration = None

Duration of the audioclip in milliseconds

filename = None

Name of the file

url = None

Url of the audio file

class fbchat.models.EmojiSize[source]

Used to specify the size of a sent emoji

LARGE = '369239383222810'
MEDIUM = '369239343222814'
SMALL = '369239263222822'
class fbchat.models.Enum[source]

Used internally by fbchat to support enumerations

exception fbchat.models.FBchatException[source]

Custom exception thrown by fbchat. All exceptions in the fbchat module inherits this

exception fbchat.models.FBchatFacebookError(message, fb_error_code=None, fb_error_message=None, request_status_code=None)[source]
fb_error_code = None

The error code that Facebook returned

fb_error_message = None

The error message that Facebook returned (In the user’s own language)

request_status_code = None

The status code that was sent in the http response (eg. 404) (Usually only set if not successful, aka. not 200)

exception fbchat.models.FBchatUserError[source]

Thrown by fbchat when wrong values are entered

class fbchat.models.FileAttachment(url=None, size=None, name=None, is_malicious=None, **kwargs)[source]

Represents a file that has been sent as a Facebook attachment

is_malicious = None

Whether Facebook determines that this file may be harmful

name = None

Name of the file

size = None

Size of the file in bytes

url = None

Url where you can download the file

class fbchat.models.Group(uid, participants=None, nicknames=None, color=None, emoji=None, **kwargs)[source]

Represents a Facebook group. Inherits Thread

color = None

A ThreadColor. The groups’s message color

emoji = None

The groups’s default emoji

nicknames = None

A dict, containing user nicknames mapped to their IDs

participants = None

Unique list (set) of the group thread’s participant user IDs

class fbchat.models.ImageAttachment(original_extension=None, width=None, height=None, is_animated=None, thumbnail_url=None, preview=None, large_preview=None, animated_preview=None, **kwargs)[source]

Represents an image that has been sent as a Facebook attachment To retrieve the full image url, use: fbchat.Client.fetchImageUrl, and pass it the uid of the image attachment

animated_preview_height = None

Height of the animated preview image

animated_preview_url = None

URL to an animated preview of the image (eg. for gifs)

animated_preview_width = None

Width of the animated preview image

height = None

Height of original image

is_animated = None

Whether the image is animated

large_preview_height = None

Height of the large preview image

large_preview_url = None

URL to a large preview of the image

large_preview_width = None

Width of the large preview image

original_extension = None

The extension of the original image (eg. ‘png’)

preview_height = None

Height of the medium preview image

preview_url = None

URL to a medium preview of the image

preview_width = None

Width of the medium preview image

thumbnail_url = None

URL to a thumbnail of the image

width = None

Width of original image

class fbchat.models.Mention(thread_id, offset=0, length=10)[source]

Represents a @mention

length = None

The length of the mention

offset = None

The character where the mention starts

thread_id = None

The thread ID the mention is pointing at

class fbchat.models.Message(text=None, mentions=None, emoji_size=None, sticker=None, attachments=None)[source]

Represents a Facebook message

attachments = None

A list of attachments

author = None

ID of the sender

emoji_size = None

A EmojiSize. Size of a sent emoji

is_read = None

Whether the message is read

mentions = None

A list of Mention objects

reactions = None

A dict with user’s IDs as keys, and their MessageReaction as values

sticker = None

A Sticker

text = None

The actual message

timestamp = None

Timestamp of when the message was sent

uid = None

The message ID

class fbchat.models.MessageReaction[source]

Used to specify a message reaction

ANGRY = '😠'
LOVE = '😍'
NO = '👎'
SAD = '😢'
SMILE = '😆'
WOW = '😮'
YES = '👍'
class fbchat.models.Page(uid, url=None, city=None, likes=None, sub_title=None, category=None, **kwargs)[source]

Represents a Facebook page. Inherits Thread

category = None

The page’s category

city = None

The name of the page’s location city

likes = None

Amount of likes the page has

sub_title = None

Some extra information about the page

url = None

The page’s custom url

class fbchat.models.Room(uid, admins=None, approval_mode=None, approval_requests=None, join_link=None, privacy_mode=None, **kwargs)[source]

Represents a Facebook room. Inherits Group

admins = None
approval_mode = None
approval_requests = None
privacy_mode = None
class fbchat.models.ShareAttachment(**kwargs)[source]

Represents a shared item (eg. URL) that has been sent as a Facebook attachment - Currently Incomplete!

class fbchat.models.Sticker(*args, **kwargs)[source]

Represents a Facebook sticker that has been sent to a Facebook thread as an attachment

frame_rate = None

The frame rate the spritemap is intended to be played in

frames_per_col = None

The amount of frames present in the spritemap pr. coloumn

frames_per_row = None

The amount of frames present in the spritemap pr. row

height = None

Height of the sticker

is_animated = False

Whether the sticker is animated

label = None

The sticker’s label/name

large_sprite_image = None

URL to a large spritemap

medium_sprite_image = None

URL to a medium spritemap

pack = None

The sticker-pack’s ID

url = None

URL to the sticker’s image

width = None

Width of the sticker

class fbchat.models.Thread(_type, uid, photo=None, name=None, last_message_timestamp=None, message_count=None)[source]

Represents a Facebook thread

last_message_timestamp = None

Timestamp of last message

message_count = None

Number of messages in the thread

name = None

The name of the thread

photo = None

A url to the thread’s picture

type = None

Specifies the type of thread. Can be used a thread_type. See Threads for more info

uid = None

The unique identifier of the thread. Can be used a thread_id. See Threads for more info

class fbchat.models.ThreadColor[source]

Used to specify a thread colors

BILOBA_FLOWER = '#a695c7'
BRILLIANT_ROSE = '#ff5ca1'
CAMEO = '#d4a88c'
DEEP_SKY_BLUE = '#20cef5'
FERN = '#67b868'
FREE_SPEECH_GREEN = '#13cf13'
GOLDEN_POPPY = '#ffc300'
LIGHT_CORAL = '#e68585'
MEDIUM_SLATE_BLUE = '#7646ff'
MESSENGER_BLUE = '#0084ff'
PICTON_BLUE = '#6699cc'
PUMPKIN = '#ff7e29'
RADICAL_RED = '#fa3c4c'
SHOCKING = '#d696bb'
VIKING = '#44bec7'
class fbchat.models.ThreadLocation[source]

Used to specify where a thread is located (inbox, pending, archived, other).

ARCHIVED = 'ARCHIVED'
INBOX = 'INBOX'
OTHER = 'OTHER'
PENDING = 'PENDING'
class fbchat.models.ThreadType[source]

Used to specify what type of Facebook thread is being used. See Threads for more info

GROUP = 2
PAGE = 3
ROOM = 4
USER = 1
class fbchat.models.TypingStatus[source]

Used to specify whether the user is typing or has stopped typing

STOPPED = 0
TYPING = 1
class fbchat.models.User(uid, url=None, first_name=None, last_name=None, is_friend=None, gender=None, affinity=None, nickname=None, own_nickname=None, color=None, emoji=None, **kwargs)[source]

Represents a Facebook user. Inherits Thread

affinity = None

From 0 to 1. How close the client is to the user

color = None

A ThreadColor. The message color

emoji = None

The default emoji

first_name = None

The users first name

gender = None

The user’s gender

is_friend = None

Whether the user and the client are friends

last_name = None

The users last name

nickname = None

The user’s nickname

own_nickname = None

The clients nickname, as seen by the user

url = None

The profile url

class fbchat.models.VideoAttachment(size=None, width=None, height=None, duration=None, preview_url=None, small_image=None, medium_image=None, large_image=None, **kwargs)[source]

Represents a video that has been sent as a Facebook attachment

duration = None

Length of video in milliseconds

height = None

Height of original video

large_image_height = None

Height of the large preview image

large_image_url = None

URL to a large preview image of the video

large_image_width = None

Width of the large preview image

medium_image_height = None

Height of the medium preview image

medium_image_url = None

URL to a medium preview image of the video

medium_image_width = None

Width of the medium preview image

preview_url = None

URL to very compressed preview video

size = None

Size of the original video in bytes

small_image_height = None

Height of the small preview image

small_image_url = None

URL to a small preview image of the video

small_image_width = None

Width of the small preview image

width = None

Width of original video

Utils

These functions and values are used internally by fbchat, and are subject to change. Do NOT rely on these to be backwards compatible!

class fbchat.utils.ReqUrl[source]

A class containing all urls used by fbchat

fbchat.utils.USER_AGENTS = ['Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36', 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_3) AppleWebKit/601.1.10 (KHTML, like Gecko) Version/8.0.5 Safari/601.1.10', 'Mozilla/5.0 (Windows NT 6.3; WOW64; ; NCT50_AAP285C84A1328) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36', 'Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.1 (KHTML, like Gecko) Chrome/22.0.1207.1 Safari/537.1', 'Mozilla/5.0 (X11; CrOS i686 2268.111.0) AppleWebKit/536.11 (KHTML, like Gecko) Chrome/20.0.1132.57 Safari/536.11', 'Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/536.6 (KHTML, like Gecko) Chrome/20.0.1092.0 Safari/536.6']

Default list of user agents

fbchat.utils.random() → x in the interval [0, 1).