Message - Read and send messages

Message - Read and send messages

class xbox.webapi.api.provider.message.MessageProvider(client)

Bases: xbox.webapi.api.provider.baseprovider.BaseProvider

MSG_URL = 'https://msg.xboxlive.com'
HEADERS_MESSAGE = {'x-xbl-contract-version': '1'}
get_message_inbox(skip_items=0, max_items=100)

Get messages

Parameters:
  • skip_items (int) – Item count to skip
  • max_items (int) – Maximum item count to load
Returns:

HTTP Response

Return type:

requests.Response

get_message(message_id)

Get detailed message info

Parameters:message_id (str) – Message Id
Returns:HTTP Response
Return type:requests.Response
delete_message(message_id)

Delete message

NOTE: Returns HTTP Status Code 204 on success

Parameters:message_id (str) – Message Id
Returns:HTTP Response
Return type:requests.Response
send_message(message_text, gamertags=None, xuids=None)

Send message to a list of gamertags

Only one of each recipient types can be supplied, either gamertags or xuids

Parameters:gamertags (list) – List of gamertags
Returns:HTTP Response
Return type:requests.Response